Re: [PATCH 00/15] Translate sphinx-pre-install to Python

[Akira Yokosawa <akiyks@gmail.com>]

Hi Mauro,

On Mon, 30 Jun 2025 23:34:48 +0200, Mauro Carvalho Chehab wrote:
[...]

> The test script also ran the install procedure for system,
> venv and native Sphinx install.

Which install procedure did you test?  The short one with the "--no-pdf"
option?

I am asking because installing the full list of packages in podman run
of opensuse/leap:15.6 didn't complete successfully for me.

And by the look of things, you stopped at installation, because you are
well aware of all the issues in running "make htmldocs" and its friends
after the install.

I assume you (or somebody else) are going to update the script once this
series is applied to make the suggested lists of packages be useful for
newcomers.

> The tests were done with those containers, obtained from
> lxc download templates or via podman run:
[...]

> It also properly detected RHEL 8 string:
> 
> Detected OS                : Red Hat Enterprise Linux release 8.10 (Ootpa).
> Installing venv            : WARNING: No such file or directory: 'sphinx-build'
> Installing package_install : WARNING: No such file or directory: 'sphinx-build'
> 
> But, at this particular docker container, no repositories had
> python3-sphinx nor python3-virtualenv, but I suspect that this
> is a problem on this particular image, as I'm almost sure we
> tested RHEL 8 in the past, so, I have hopes that this could
> still work with real RHEL, if it has Python >= 3.7.

FWIW, almalinux 8 provides python3-sphinx in the "PowerTools" repo.
It installs Sphinx 1.7.6 on top of python 3.6.8.
python3-virtualenv is in the "AppStream" repo. It also comes with
python 3.6.8.

> 
> Yet, our goal is to support the latest LTS version, so
> RHEL 8 is out of scope.

Yes, I think it is reasonable to ignore RHEL 8 and its clones.

For the record, here is a WIP scorecard of suggested procedure by
actually running "make htmldocs" and its friends after installing distro
packages (if it succeeds):

------------------------------------------------------------------------
* debian:12

htmldocs:  OK
latexdocs: NG

Debian and its derivative prohibit convert(1) (of ImageMagick) from
generating PDF by their default policy, so you'll get a bunch of:

[while building userspace-api.tex]

WARNING: Error #1 when calling: /usr/bin/convert /<srcdir>/Documentation/userspace-api/media/typical_media_device.svg /<srcdir>/Documentation/output/userspace-api/latex/typical_media_device.pdf
WARNING: Warning msg from convert(1): convert: attempt to perform an operation not allowed by the security policy `PDF' @ error/constitute.c/IsCoderAuthorized/426.

, and if you ignore them and try to build PDF, you'll get:

[while building userspace-api.pdf]

! Dimension too large.
\spx@boxes@fcolorbox ...dimexpr \ht \spx@tempboxa 
                                                  +\spx@boxes@border@top +\s...
l.54887 \end{sphinxVerbatim}
                            
? 
! Emergency stop.
\spx@boxes@fcolorbox ...dimexpr \ht \spx@tempboxa 
                                                  +\spx@boxes@border@top +\s...
l.54887 \end{sphinxVerbatim}

* fedora:latest (42)

htmldocs:  NG

Container images of fedora has stopped having "which" as a command.
You need to install it manually.  After installing "which": OK

pdfdocs:  OK

* opensuse/leap:15.6

htmldocs:  NG
After installing "which": OK

latexdocs: NG
Can't complete "zypper install" inside a podman container run using the
full package list ???
------------------------------------------------------------------------

Having look at these poor results, I don't see any reason to continue
testing further.

Regards,
Akira