Lukas Bulwahn <lukas.bulwahn@xxxxxxxxx> writes: > 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@xxxxxxxxxxxx/ > Link: https://lore.kernel.org/linux-doc/20240226093854.47830-1-lukas.bulwahn@xxxxxxxxx/ > Reviewed-by: Akira Yokosawa <akiyks@xxxxxxxxx> > Tested-by: Vegard Nossum <vegard.nossum@xxxxxxxxxx> > Signed-off-by: Lukas Bulwahn <lukas.bulwahn@xxxxxxxxx> > --- > v1 -> v2: > drop jinja2 as suggested by Vegard. > add tags from v1 review > > Documentation/doc-guide/sphinx.rst | 11 ++++++----- > Documentation/sphinx/requirements.txt | 7 ++----- > scripts/sphinx-pre-install | 19 +++---------------- > 3 files changed, 11 insertions(+), 26 deletions(-) I've applied this - thanks. jon
