linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: corbet@lwn.net, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 00/11] Fix PDF doc builds on major distros
Date: Mon, 18 Aug 2025 11:42:20 +0200	[thread overview]
Message-ID: <20250818114220.7f82d2f7@foz.lan> (raw)
In-Reply-To: <816ec5d2-33ea-4399-86e6-51ddc20ead28@gmail.com>

Em Mon, 18 Aug 2025 09:44:39 +0900
Akira Yokosawa <akiyks@gmail.com> escreveu:

> On Mon, 18 Aug 2025 01:07:24 +0900, Akira Yokosawa wrote:
> [...]
> 
> > 
> > Ah, I have finally understood what 5/11 is trying to do.
> > 
> > Its changelog mainly talks about an issue you saw after adding options
> > to xindy in that same commit, and you added
> > 
> >    \newfontfamily\headingfont{DejaVu Serif}
> > 
> > to resolve it.  
> 
> Sidenote:
> 
> It looks like texlive-xindy is not available for RHEL based distros.

On several rpm-based distros, extra repositories are needed.

So, if you take a look at rpmfind:
	https://rpmfind.net/linux/rpm2html/search.php?query=python3-sphinx

For the limited set of distros supported there, you'll see that sphinx-build
can either be at:
	- main distro repos;
	- CRB;
	- Powertools

But this is only a fraction of the problem, as there are several
exceptions. For instance, RHEL8 from "redhat/ubi8" docker container(*) 
sounds to be an official vendor-provided image.

(*) https://hub.docker.com/r/redhat/ubi8

Yet, if you use it and try to install sphinx-build:

	# dnf install python3-sphinx
	Updating Subscription Management repositories.
	Unable to read consumer identity

	This system is not registered with an entitlement server. You can use subscription-manager to register.

	Last metadata expiration check: 21:10:22 ago on Sun Aug 17 11:30:23 2025.
	No match for argument: python3-sphinx
	Error: Unable to find a match: python3-sphinx

It won't work, because repo management in this case requires to setup
a paywall protected procedure.

> That means, you will need to ask EPEL to provide it.
> Otherwise, you are obsoleting those distros for pdfdocs build
> (under the confinement of "distro packages only").

Recommending a repository setup for rpm distros is complex. When
I wrote sphinx-pre-install, I opted to keep such setup out of it.

The rationale is that the ones using such distros should know
better and may require a paid subscription.

With the exception of rpmfusion on Fedora, where one needs to first
download a RPM file from some site, for most distros, the extra
needed repositories are already installed or can be installed from
a package provided at the main repository. Once downloaded,
all it takes is to enable it. 

For instance, to get what is needed to build both html and pdf on 
RockyLinux, one needs to install a distro package:

	dnf install -y epel-release

Which adds extra repositories to /etc/yum.repos.d/.

Then, either use config-manager:

	# change "enable" flag from /etc/yum.repos.d/ repos
	dnf install 'dnf-command(config-manager)'
	dnf config-manager --set-enabled powertools appstream epel

or pass an extra option to enable the repo(s) during install:

	sudo dnf --enablrepo=powertools --enablrepo=appstream --enablrepo=epel install -y python3-sphinx {other packages}

Now, sphinx-pre-install can later be improved to also contain
repo-management instructions but this is out of the scope of this
series (and I'm not sure if it is worth adding it there).
	
Thanks,
Mauro

  reply	other threads:[~2025-08-18  9:42 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-15 11:36 [PATCH 00/11] Fix PDF doc builds on major distros Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 01/11] docs: Makefile: Fix LaTeX paper size settings Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 02/11] docs: conf.py: better handle latex documents Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 03/11] docs: conf.py: fix doc name with SPHINXDIRS Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 04/11] docs: conf.py: rename some vars at latex_documents logic Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 05/11] docs: conf.py: fix some troubles for LaTeX output Mauro Carvalho Chehab
2025-08-20  8:16   ` Akira Yokosawa
2025-08-15 11:36 ` [PATCH 06/11] scripts: sphinx-pre-install: fix PDF build issues on Ubuntu Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 07/11] scripts: sphinx-pre-install: add missing gentoo pdf dependencies Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 08/11] scripts: sphinx-pre-install: fix PDF dependencies for openSuse Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 09/11] scripts: sphinx-pre-install: fix dependencies for OpenMandriva Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 10/11] scripts: sphinx-pre-install: fix pdf dependencies for Mageia 9 Mauro Carvalho Chehab
2025-08-15 11:36 ` [PATCH 11/11] scripts: sphinx-pre-install: fix PDF dependencies for gentoo Mauro Carvalho Chehab
2025-08-16  5:06 ` [PATCH 00/11] Fix PDF doc builds on major distros Akira Yokosawa
2025-08-16 11:55   ` Mauro Carvalho Chehab
2025-08-17  9:46     ` Akira Yokosawa
2025-08-17 11:36       ` Mauro Carvalho Chehab
2025-08-17 12:24         ` Akira Yokosawa
2025-08-17 13:45           ` Mauro Carvalho Chehab
2025-08-17 16:07             ` Akira Yokosawa
2025-08-18  0:44               ` Akira Yokosawa
2025-08-18  9:42                 ` Mauro Carvalho Chehab [this message]
2025-08-18 10:06                   ` Akira Yokosawa
2025-08-18 11:35                     ` Mauro Carvalho Chehab
2025-08-18 12:00                       ` Akira Yokosawa
2025-08-18 17:07               ` Jonathan Corbet
2025-08-18 23:26                 ` Akira Yokosawa
2025-08-19  1:02                   ` Mauro Carvalho Chehab
2025-08-19  2:16                     ` Akira Yokosawa
2025-08-19 13:32                       ` Mauro Carvalho Chehab
2025-08-19 23:54                         ` Akira Yokosawa
2025-08-20  7:15                           ` Mauro Carvalho Chehab
2025-08-20 11:41                             ` Akira Yokosawa
2025-08-20 16:48                               ` Mauro Carvalho Chehab
2025-08-20 23:53                                 ` Akira Yokosawa
2025-08-21  0:09                                   ` Akira Yokosawa
2025-08-21  7:52                                     ` Mauro Carvalho Chehab
2025-08-21  7:56                                       ` Mauro Carvalho Chehab
2025-08-21  9:12                                     ` Inkscape - Was: " Mauro Carvalho Chehab
2025-08-18 16:59       ` Jonathan Corbet
2025-08-17 15:32 ` Vegard Nossum
2025-08-18  8:33   ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250818114220.7f82d2f7@foz.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).