p71924506
/
linux_old1
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: requirements.txt: recommend Sphinx 1.7.9 

As discussed at the linux-doc ML, while we'll still support
version 1.3, it is time to recommend a more modern version.

So, let's switch the minimal requirements to Sphinx 1.7.9,
as it has the "-jauto" flag, with makes a lot faster when
building documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2019-05-29 20:09:32 -03:00 committed by Jonathan Corbet
parent cf08508d21
commit a700767a76
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/doc-guide/sphinx.rst
View File

@ -27,8 +27,7 @@ Sphinx Install
============== ==============
The ReST markups currently used by the Documentation/ files are meant to be The ReST markups currently used by the Documentation/ files are meant to be
built with ``Sphinx`` version 1.3 or higher. If you desire to build built with ``Sphinx`` version 1.3 or higher.
PDF output, it is recommended to use version 1.4.6 or higher.
There's a script that checks for the Sphinx requirements. Please see There's a script that checks for the Sphinx requirements. Please see
:ref:`sphinx-pre-install` for further details. :ref:`sphinx-pre-install` for further details.
@ -56,13 +55,13 @@ or ``virtualenv``, depending on how your distribution packaged Python 3.
those expressions are written using LaTeX notation. It needs texlive those expressions are written using LaTeX notation. It needs texlive
installed with amdfonts and amsmath in order to evaluate them. installed with amdfonts and amsmath in order to evaluate them.
In summary, if you want to install Sphinx version 1.4.9, you should do:: In summary, if you want to install Sphinx version 1.7.9, you should do::
$ virtualenv sphinx_1.4 $ virtualenv sphinx_1.7.9
$ . sphinx_1.4/bin/activate $ . sphinx_1.7.9/bin/activate
(sphinx_1.4) $ pip install -r Documentation/sphinx/requirements.txt (sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt
After running ``. sphinx_1.4/bin/activate``, the prompt will change, After running ``. sphinx_1.7.9/bin/activate``, the prompt will change,
in order to indicate that you're using the new environment. If you in order to indicate that you're using the new environment. If you
open a new shell, you need to rerun this command to enter again at open a new shell, you need to rerun this command to enter again at
the virtual environment before building the documentation. the virtual environment before building the documentation.
@ -105,8 +104,8 @@ command line options for your distro::
You should run: You should run:
sudo dnf install -y texlive-luatex85 sudo dnf install -y texlive-luatex85
/usr/bin/virtualenv sphinx_1.4 /usr/bin/virtualenv sphinx_1.7.9
. sphinx_1.4/bin/activate . sphinx_1.7.9/bin/activate
pip install -r Documentation/sphinx/requirements.txt pip install -r Documentation/sphinx/requirements.txt
Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468. Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.

4
Documentation/sphinx/requirements.txt
View File

@ -1,3 +1,3 @@
docutils==0.12 docutils
Sphinx==1.4.9 Sphinx==1.7.9
sphinx_rtd_theme sphinx_rtd_theme