Building of docs does not work anymore

Building of docs does not work anymore

[Thomas Huth]

  Hi Paolo, hi John,

since the recent reworks with the Python venv, building of the docs does not 
work for me on my RHEL 8 installation anymore.

If I just run "configure" without any additional arguments, I get:

------------------------- 8< -----------------------------
$ ./configure
Using './build' as the directory for build output
python determined to be '/usr/bin/python3.8'
python version: Python 3.8.13
mkvenv: Creating non-isolated virtual environment at 'pyvenv'
mkvenv: checking for meson>=0.63.0
mkvenv: installing meson>=0.63.0
mkvenv: checking for sphinx>=1.6.0, sphinx-rtd-theme>=0.5.0

*** Ouch! ***

Could not provide build dependency 'sphinx>=1.6.0':
  • Python package 'sphinx' was not found nor installed.
  • mkvenv was configured to operate offline and did not check PyPI.
  • 'sphinx-build' was detected on your system at '/usr/bin/sphinx-build', 
but the Python package 'sphinx' was not found by this Python interpreter 
('/usr/bin/python3.8'). Typically this means that 'sphinx-build' has been 
installed against a different Python interpreter on your system.

Sphinx not found/usable, disabling docs.
------------------------- 8< -----------------------------

If I enable downloads and enforce --enable-docs , I get:

------------------------- 8< -----------------------------
./configure --enable-docs --enable-download
Using './build' as the directory for build output
python determined to be '/usr/bin/python3.8'
python version: Python 3.8.13
mkvenv: Creating non-isolated virtual environment at 'pyvenv'
mkvenv: checking for meson>=0.63.0
mkvenv: installing meson>=0.63.0
mkvenv: checking for sphinx>=1.6.0, sphinx-rtd-theme>=0.5.0
mkvenv: installing sphinx>=1.6.0, sphinx-rtd-theme>=0.5.0
ERROR: sphinx-rtd-theme 1.2.1 has requirement docutils<0.19, but you'll have 
docutils 0.20.1 which is incompatible.
ERROR: sphinx-rtd-theme 1.2.1 has requirement sphinx<7,>=1.6, but you'll 
have sphinx 7.0.1 which is incompatible.
------------------------- 8< -----------------------------

Any idea how to fix that?

  Thomas

Re: Building of docs does not work anymore

[Thomas Huth]

On 07/06/2023 11.42, Thomas Huth wrote:
> 
>   Hi Paolo, hi John,
> 
> since the recent reworks with the Python venv, building of the docs does not 
> work for me on my RHEL 8 installation anymore.
> 
> If I just run "configure" without any additional arguments, I get:
> 
> ------------------------- 8< -----------------------------
> $ ./configure
> Using './build' as the directory for build output
> python determined to be '/usr/bin/python3.8'
> python version: Python 3.8.13
> mkvenv: Creating non-isolated virtual environment at 'pyvenv'
> mkvenv: checking for meson>=0.63.0
> mkvenv: installing meson>=0.63.0
> mkvenv: checking for sphinx>=1.6.0, sphinx-rtd-theme>=0.5.0
> 
> *** Ouch! ***
> 
> Could not provide build dependency 'sphinx>=1.6.0':
>   • Python package 'sphinx' was not found nor installed.
>   • mkvenv was configured to operate offline and did not check PyPI.
>   • 'sphinx-build' was detected on your system at '/usr/bin/sphinx-build', 
> but the Python package 'sphinx' was not found by this Python interpreter 
> ('/usr/bin/python3.8'). Typically this means that 'sphinx-build' has been 
> installed against a different Python interpreter on your system.
> 
> Sphinx not found/usable, disabling docs.
> ------------------------- 8< -----------------------------
> 
> If I enable downloads and enforce --enable-docs , I get:
> 
> ------------------------- 8< -----------------------------
> ./configure --enable-docs --enable-download
> Using './build' as the directory for build output
> python determined to be '/usr/bin/python3.8'
> python version: Python 3.8.13
> mkvenv: Creating non-isolated virtual environment at 'pyvenv'
> mkvenv: checking for meson>=0.63.0
> mkvenv: installing meson>=0.63.0
> mkvenv: checking for sphinx>=1.6.0, sphinx-rtd-theme>=0.5.0
> mkvenv: installing sphinx>=1.6.0, sphinx-rtd-theme>=0.5.0
> ERROR: sphinx-rtd-theme 1.2.1 has requirement docutils<0.19, but you'll have 
> docutils 0.20.1 which is incompatible.
> ERROR: sphinx-rtd-theme 1.2.1 has requirement sphinx<7,>=1.6, but you'll 
> have sphinx 7.0.1 which is incompatible.
> ------------------------- 8< -----------------------------

Actually, it seems like it builds the docs in the latter case ... but the 
two error messages still look quite menacing (printed with red letters).

  Thomas

Re: Building of docs does not work anymore

[John Snow]

On Wed, Jun 7, 2023 at 5:46 AM Thomas Huth <thuth@redhat.com> wrote:
>
> On 07/06/2023 11.42, Thomas Huth wrote:
> >
> >   Hi Paolo, hi John,
> >
> > since the recent reworks with the Python venv, building of the docs does not
> > work for me on my RHEL 8 installation anymore.
> >
> > If I just run "configure" without any additional arguments, I get:
> >
> > ------------------------- 8< -----------------------------
> > $ ./configure
> > Using './build' as the directory for build output
> > python determined to be '/usr/bin/python3.8'
> > python version: Python 3.8.13
> > mkvenv: Creating non-isolated virtual environment at 'pyvenv'
> > mkvenv: checking for meson>=0.63.0
> > mkvenv: installing meson>=0.63.0
> > mkvenv: checking for sphinx>=1.6.0, sphinx-rtd-theme>=0.5.0
> >
> > *** Ouch! ***
> >
> > Could not provide build dependency 'sphinx>=1.6.0':
> >   • Python package 'sphinx' was not found nor installed.
> >   • mkvenv was configured to operate offline and did not check PyPI.
> >   • 'sphinx-build' was detected on your system at '/usr/bin/sphinx-build',
> > but the Python package 'sphinx' was not found by this Python interpreter
> > ('/usr/bin/python3.8'). Typically this means that 'sphinx-build' has been
> > installed against a different Python interpreter on your system.
> >
> > Sphinx not found/usable, disabling docs.
> > ------------------------- 8< -----------------------------

Looks right as far as I can see. Should this behave differently, do you think?

> >
> > If I enable downloads and enforce --enable-docs , I get:
> >
> > ------------------------- 8< -----------------------------
> > ./configure --enable-docs --enable-download
> > Using './build' as the directory for build output
> > python determined to be '/usr/bin/python3.8'
> > python version: Python 3.8.13
> > mkvenv: Creating non-isolated virtual environment at 'pyvenv'
> > mkvenv: checking for meson>=0.63.0
> > mkvenv: installing meson>=0.63.0
> > mkvenv: checking for sphinx>=1.6.0, sphinx-rtd-theme>=0.5.0
> > mkvenv: installing sphinx>=1.6.0, sphinx-rtd-theme>=0.5.0
> > ERROR: sphinx-rtd-theme 1.2.1 has requirement docutils<0.19, but you'll have
> > docutils 0.20.1 which is incompatible.
> > ERROR: sphinx-rtd-theme 1.2.1 has requirement sphinx<7,>=1.6, but you'll
> > have sphinx 7.0.1 which is incompatible.
> > ------------------------- 8< -----------------------------
>
> Actually, it seems like it builds the docs in the latter case ... but the
> two error messages still look quite menacing (printed with red letters).
>
>   Thomas

Hm, in this case it appears that the latest versions of these packages
for Python 3.8 actually conflict with each other, which is ... funny.
I would think that in this case:

1. You don't have existing Python3.8 packages if it isn't your
system's native Python interpreter
2. Pip should have not chosen packages that conflict with each other ...

Can you do me a favor and try:

> python3.8 -m pip list

and tell me what packages it says you have there?

When I run "pip install sphinx>=1.6.0 sphinx-rtd-theme>=0.5.0" in a
fresh Python3.8 virtual environment, it chooses these versions:
- Sphinx 6.2.1
- sphinx-rtd-theme 1.2.2

Seems like Sphinx 7.0.1 is quite a bit too new for this, I wonder why
it chose it?

--js