On Tue, Feb 27, 2024 at 2:14 PM Lukas Bulwahn <lukas.bulwahn@xxxxxxxxx> wrote: > > 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. > 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/ > > Signed-off-by: Lukas Bulwahn <lukas.bulwahn@xxxxxxxxx> Oops, I was a bit quick on sending this out, I wanted to add those remarks for the patch discussion: This change seems to work for my setup, but I have really only dipped my toes into the waters of this sphinx-pre-install script. I only dropped the version constraints, but possibly one can even drop some of the packages in the requirements.txt, as they are pulled in automatically by Sphinx dependencies. So, I am happy to get your feedback, but I am well aware about its potential to be improved and the lack of my deep knowledge about the script. I hope, though, you can test it in your setup and confirm if it works as expected and then we can discuss the details (e.g., naming). Lukas
