diff options
author | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2019-05-29 19:09:32 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2019-05-30 12:42:05 -0400 |
commit | a700767a7682d9bd237e927253274859aee075e7 (patch) | |
tree | 0bc37e2916f2120818fcc4a49f94801f4c8b812f | |
parent | cf08508d21ffae5aea6c7dcb771ebd28612c6120 (diff) |
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>
-rw-r--r-- | Documentation/doc-guide/sphinx.rst | 17 | ||||
-rw-r--r-- | Documentation/sphinx/requirements.txt | 4 |
2 files changed, 10 insertions, 11 deletions
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index c039224b404e..4ba081f43e98 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst | |||
@@ -27,8 +27,7 @@ Sphinx Install | |||
27 | ============== | 27 | ============== |
28 | 28 | ||
29 | The ReST markups currently used by the Documentation/ files are meant to be | 29 | The ReST markups currently used by the Documentation/ files are meant to be |
30 | built with ``Sphinx`` version 1.3 or higher. If you desire to build | 30 | built with ``Sphinx`` version 1.3 or higher. |
31 | PDF output, it is recommended to use version 1.4.6 or higher. | ||
32 | 31 | ||
33 | There's a script that checks for the Sphinx requirements. Please see | 32 | There's a script that checks for the Sphinx requirements. Please see |
34 | :ref:`sphinx-pre-install` for further details. | 33 | :ref:`sphinx-pre-install` for further details. |
@@ -56,13 +55,13 @@ or ``virtualenv``, depending on how your distribution packaged Python 3. | |||
56 | those expressions are written using LaTeX notation. It needs texlive | 55 | those expressions are written using LaTeX notation. It needs texlive |
57 | installed with amdfonts and amsmath in order to evaluate them. | 56 | installed with amdfonts and amsmath in order to evaluate them. |
58 | 57 | ||
59 | In summary, if you want to install Sphinx version 1.4.9, you should do:: | 58 | In summary, if you want to install Sphinx version 1.7.9, you should do:: |
60 | 59 | ||
61 | $ virtualenv sphinx_1.4 | 60 | $ virtualenv sphinx_1.7.9 |
62 | $ . sphinx_1.4/bin/activate | 61 | $ . sphinx_1.7.9/bin/activate |
63 | (sphinx_1.4) $ pip install -r Documentation/sphinx/requirements.txt | 62 | (sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt |
64 | 63 | ||
65 | After running ``. sphinx_1.4/bin/activate``, the prompt will change, | 64 | After running ``. sphinx_1.7.9/bin/activate``, the prompt will change, |
66 | in order to indicate that you're using the new environment. If you | 65 | in order to indicate that you're using the new environment. If you |
67 | open a new shell, you need to rerun this command to enter again at | 66 | open a new shell, you need to rerun this command to enter again at |
68 | the virtual environment before building the documentation. | 67 | the virtual environment before building the documentation. |
@@ -105,8 +104,8 @@ command line options for your distro:: | |||
105 | You should run: | 104 | You should run: |
106 | 105 | ||
107 | sudo dnf install -y texlive-luatex85 | 106 | sudo dnf install -y texlive-luatex85 |
108 | /usr/bin/virtualenv sphinx_1.4 | 107 | /usr/bin/virtualenv sphinx_1.7.9 |
109 | . sphinx_1.4/bin/activate | 108 | . sphinx_1.7.9/bin/activate |
110 | pip install -r Documentation/sphinx/requirements.txt | 109 | pip install -r Documentation/sphinx/requirements.txt |
111 | 110 | ||
112 | Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468. | 111 | Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468. |
diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt index 742be3e12619..14e29a0ae480 100644 --- a/Documentation/sphinx/requirements.txt +++ b/Documentation/sphinx/requirements.txt | |||
@@ -1,3 +1,3 @@ | |||
1 | docutils==0.12 | 1 | docutils |
2 | Sphinx==1.4.9 | 2 | Sphinx==1.7.9 |
3 | sphinx_rtd_theme | 3 | sphinx_rtd_theme |