linux/Documentation/sphinx
Lukas Bulwahn b31274d58d docs: drop the version constraints for sphinx and dependencies
As discussed (see Links), there is some inertia to move to the recent
Sphinx versions for the doc build environment.

As first step, drop the version constraints and the related comments. As
sphinx depends on jinja2, jinja2 is pulled in automatically. So drop that.
Then, the sphinx-pre-install script will fail though with:

  Can't get default sphinx version from ./Documentation/sphinx/requirements.txt at ./scripts/sphinx-pre-install line 305.

The script simply expects to parse a version constraint with Sphinx in the
requirements.txt. That version is used in the script for suggesting the
virtualenv directory name.

To suggest a virtualenv directory name, when there is no version given in
the requirements.txt, one could try to guess the version that would be
downloaded with 'pip install -r Documentation/sphinx/requirements.txt'.
However, there seems no simple way to get that version without actually
setting up the venv and running pip. So, instead, name the directory with
the fixed name 'sphinx_latest'.

Finally update the Sphinx build documentation to reflect this directory
name change.

Link: https://lore.kernel.org/linux-doc/874jf4m384.fsf@meer.lwn.net/
Link: https://lore.kernel.org/linux-doc/20240226093854.47830-1-lukas.bulwahn@gmail.com/
Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
Tested-by: Vegard Nossum <vegard.nossum@oracle.com>
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20240301141800.30218-1-lukas.bulwahn@gmail.com>
2024-03-03 08:17:20 -07:00
..
templates docs/sphinx: Fix TOC scroll hack for the home page 2024-01-23 14:33:13 -07:00
automarkup.py docs: Raise the minimum Sphinx requirement to 2.4.4 2023-12-15 08:36:33 -07:00
cdomain.py docs: Raise the minimum Sphinx requirement to 2.4.4 2023-12-15 08:36:33 -07:00
kernel_abi.py docs: kernel_abi.py: fix command injection 2024-01-03 13:44:11 -07:00
kernel_feat.py docs: kernel_feat.py: fix build error for missing files 2024-02-21 13:44:21 -07:00
kernel_include.py docs: kernel_include.py: add sphinx build dependencies 2022-03-28 13:53:46 -06:00
kerneldoc-preamble.sty docs: kerneldoc-preamble.sty: Remove code for Sphinx <2.4 2024-03-03 08:15:22 -07:00
kerneldoc.py doc: kerneldoc.py: fix indentation 2024-02-21 13:44:21 -07:00
kernellog.py Move our minimum Sphinx version to 1.7 2021-02-01 16:29:12 -07:00
kfigure.py docs: Raise the minimum Sphinx requirement to 2.4.4 2023-12-15 08:36:33 -07:00
load_config.py docs: Fix the docs build with Sphinx 6.0 2023-01-06 13:04:00 -07:00
maintainers_include.py Documentation/sphinx: fix Python string escapes 2023-09-12 14:27:45 -06:00
parallel-wrapper.sh docs: Fix empty parallelism argument 2020-02-25 03:11:04 -07:00
parse-headers.pl tweewide: Fix most Shebang lines 2020-12-08 23:30:04 +09:00
requirements.txt docs: drop the version constraints for sphinx and dependencies 2024-03-03 08:17:20 -07:00
rstFlatTable.py docs: sphinx: Fix couple of spellings in the file rstFlatTable.py 2021-03-06 17:36:50 -07:00
translations.py docs: translations: use attribute to store current language 2024-02-21 13:41:37 -07:00