tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: sphinx: add a file with the requirements for lowest version

Those days, it is hard to install a virtual env that would
build docs with Sphinx 3.4.3, as even python 3.13 is not
compatible anymore with it.

/usr/bin/python3.9 -m venv sphinx_3.4.3
. sphinx_3.4.3/bin/activate
pip install -r Documentation/sphinx/min_requirements.txt

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/e38a44ee64ebfa37eac5f64e47af51c7ac051d5a.1750571906.git.mchehab+huawei@kernel.org

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet 9322af5e bb4c5c50

+33
+23
Documentation/doc-guide/sphinx.rst
··· 131 131 ``--no-virtualenv`` 132 132 Use OS packaging for Sphinx instead of Python virtual environment. 133 133 134 + Installing Sphinx Minimal Version 135 + --------------------------------- 136 + 137 + When changing Sphinx build system, it is important to ensure that 138 + the minimal version will still be supported. Nowadays, it is 139 + becoming harder to do that on modern distributions, as it is not 140 + possible to install with Python 3.13 and above. 141 + 142 + Testing with the lowest supported Python version as defined at 143 + Documentation/process/changes.rst can be done by creating 144 + a venv with it with, and install minimal requirements with:: 145 + 146 + /usr/bin/python3.9 -m venv sphinx_min 147 + . sphinx_min/bin/activate 148 + pip install -r Documentation/sphinx/min_requirements.txt 149 + 150 + A more comprehensive test can be done by using: 151 + 152 + scripts/test_doc_build.py 153 + 154 + Such script create one Python venv per supported version, 155 + optionally building documentation for a range of Sphinx versions. 156 + 134 157 135 158 Sphinx Build 136 159 ============
+10
Documentation/sphinx/min_requirements.txt
··· 1 + alabaster >=0.7,<0.8 2 + docutils>=0.15,<0.18 3 + jinja2>=2.3,<3.1 4 + PyYAML>=5.1,<6.1 5 + Sphinx==3.4.3 6 + sphinxcontrib-applehelp==1.0.2 7 + sphinxcontrib-devhelp==1.0.1 8 + sphinxcontrib-htmlhelp==1.0.3 9 + sphinxcontrib-qthelp==1.0.2 10 + sphinxcontrib-serializinghtml==1.1.4