Skip to content

Commit 6d6a8d6

Browse files
akiyksJonathan Corbet
authored andcommitted
docs: Update Sphinx requirements
Commit f546ff0 ("Move our minimum Sphinx version to 1.7") raised the minimum version to 1.7. For pdfdocs, sphinx_pre_install says: note: If you want pdf, you need at least Sphinx 2.4.4. , and current requirements.txt installs Sphinx 2.4.4. Update Sphinx versions mentioned in docs and remove a note on earlier Sphinx versions. Update zh_CN and it_IT translations as well. Signed-off-by: Akira Yokosawa <[email protected]> Cc: Federico Vaga <[email protected]> Cc: Alex Shi <[email protected]> Reviewed-by: Alex Shi <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
1 parent fa55b7d commit 6d6a8d6

File tree

5 files changed

+29
-41
lines changed

5 files changed

+29
-41
lines changed

Documentation/doc-guide/sphinx.rst

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Sphinx Install
2727
==============
2828

2929
The ReST markups currently used by the Documentation/ files are meant to be
30-
built with ``Sphinx`` version 1.3 or higher.
30+
built with ``Sphinx`` version 1.7 or higher.
3131

3232
There's a script that checks for the Sphinx requirements. Please see
3333
:ref:`sphinx-pre-install` for further details.
@@ -43,10 +43,6 @@ or ``virtualenv``, depending on how your distribution packaged Python 3.
4343

4444
.. note::
4545

46-
#) Sphinx versions below 1.5 don't work properly with Python's
47-
docutils version 0.13.1 or higher. So, if you're willing to use
48-
those versions, you should run ``pip install 'docutils==0.12'``.
49-
5046
#) It is recommended to use the RTD theme for html output. Depending
5147
on the Sphinx version, it should be installed separately,
5248
with ``pip install sphinx_rtd_theme``.
@@ -55,13 +51,13 @@ or ``virtualenv``, depending on how your distribution packaged Python 3.
5551
those expressions are written using LaTeX notation. It needs texlive
5652
installed with amsfonts and amsmath in order to evaluate them.
5753

58-
In summary, if you want to install Sphinx version 1.7.9, you should do::
54+
In summary, if you want to install Sphinx version 2.4.4, you should do::
5955

60-
$ virtualenv sphinx_1.7.9
61-
$ . sphinx_1.7.9/bin/activate
62-
(sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt
56+
$ virtualenv sphinx_2.4.4
57+
$ . sphinx_2.4.4/bin/activate
58+
(sphinx_2.4.4) $ pip install -r Documentation/sphinx/requirements.txt
6359

64-
After running ``. sphinx_1.7.9/bin/activate``, the prompt will change,
60+
After running ``. sphinx_2.4.4/bin/activate``, the prompt will change,
6561
in order to indicate that you're using the new environment. If you
6662
open a new shell, you need to rerun this command to enter again at
6763
the virtual environment before building the documentation.
@@ -81,7 +77,7 @@ output.
8177
PDF and LaTeX builds
8278
--------------------
8379

84-
Such builds are currently supported only with Sphinx versions 1.4 and higher.
80+
Such builds are currently supported only with Sphinx versions 2.4 and higher.
8581

8682
For PDF and LaTeX output, you'll also need ``XeLaTeX`` version 3.14159265.
8783

@@ -104,8 +100,8 @@ command line options for your distro::
104100
You should run:
105101

106102
sudo dnf install -y texlive-luatex85
107-
/usr/bin/virtualenv sphinx_1.7.9
108-
. sphinx_1.7.9/bin/activate
103+
/usr/bin/virtualenv sphinx_2.4.4
104+
. sphinx_2.4.4/bin/activate
109105
pip install -r Documentation/sphinx/requirements.txt
110106

111107
Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.

Documentation/process/changes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ mcelog 0.6 mcelog --version
5454
iptables 1.4.2 iptables -V
5555
openssl & libcrypto 1.0.0 openssl version
5656
bc 1.06.95 bc --version
57-
Sphinx\ [#f1]_ 1.3 sphinx-build --version
57+
Sphinx\ [#f1]_ 1.7 sphinx-build --version
5858
====================== =============== ========================================
5959

6060
.. [#f1] Sphinx is needed only to build the Kernel documentation

Documentation/translations/it_IT/doc-guide/sphinx.rst

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Installazione Sphinx
3535
====================
3636

3737
I marcatori ReST utilizzati nei file in Documentation/ sono pensati per essere
38-
processati da ``Sphinx`` nella versione 1.3 o superiore.
38+
processati da ``Sphinx`` nella versione 1.7 o superiore.
3939

4040
Esiste uno script che verifica i requisiti Sphinx. Per ulteriori dettagli
4141
consultate :ref:`it_sphinx-pre-install`.
@@ -53,11 +53,6 @@ pacchettizzato dalla vostra distribuzione.
5353

5454
.. note::
5555

56-
#) Le versioni di Sphinx inferiori alla 1.5 non funzionano bene
57-
con il pacchetto Python docutils versione 0.13.1 o superiore.
58-
Se volete usare queste versioni, allora dovere eseguire
59-
``pip install 'docutils==0.12'``.
60-
6156
#) Viene raccomandato l'uso del tema RTD per la documentazione in HTML.
6257
A seconda della versione di Sphinx, potrebbe essere necessaria
6358
l'installazione tramite il comando ``pip install sphinx_rtd_theme``.
@@ -67,13 +62,13 @@ pacchettizzato dalla vostra distribuzione.
6762
utilizzando LaTeX. Per una corretta interpretazione, è necessario aver
6863
installato texlive con i pacchetti amdfonts e amsmath.
6964

70-
Riassumendo, se volete installare la versione 1.7.9 di Sphinx dovete eseguire::
65+
Riassumendo, se volete installare la versione 2.4.4 di Sphinx dovete eseguire::
7166

72-
$ virtualenv sphinx_1.7.9
73-
$ . sphinx_1.7.9/bin/activate
74-
(sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt
67+
$ virtualenv sphinx_2.4.4
68+
$ . sphinx_2.4.4/bin/activate
69+
(sphinx_2.4.4) $ pip install -r Documentation/sphinx/requirements.txt
7570

76-
Dopo aver eseguito ``. sphinx_1.7.9/bin/activate``, il prompt cambierà per
71+
Dopo aver eseguito ``. sphinx_2.4.4/bin/activate``, il prompt cambierà per
7772
indicare che state usando il nuovo ambiente. Se aprite un nuova sessione,
7873
prima di generare la documentazione, dovrete rieseguire questo comando per
7974
rientrare nell'ambiente virtuale.
@@ -94,7 +89,7 @@ Generazione in PDF e LaTeX
9489
--------------------------
9590

9691
Al momento, la generazione di questi documenti è supportata solo dalle
97-
versioni di Sphinx superiori alla 1.4.
92+
versioni di Sphinx superiori alla 2.4.
9893

9994
Per la generazione di PDF e LaTeX, avrete bisogno anche del pacchetto
10095
``XeLaTeX`` nella versione 3.14159265
@@ -119,8 +114,8 @@ l'installazione::
119114
You should run:
120115

121116
sudo dnf install -y texlive-luatex85
122-
/usr/bin/virtualenv sphinx_1.7.9
123-
. sphinx_1.7.9/bin/activate
117+
/usr/bin/virtualenv sphinx_2.4.4
118+
. sphinx_2.4.4/bin/activate
124119
pip install -r Documentation/sphinx/requirements.txt
125120

126121
Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.

Documentation/translations/it_IT/process/changes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ mcelog 0.6 mcelog --version
5757
iptables 1.4.2 iptables -V
5858
openssl & libcrypto 1.0.0 openssl version
5959
bc 1.06.95 bc --version
60-
Sphinx\ [#f1]_ 1.3 sphinx-build --version
60+
Sphinx\ [#f1]_ 1.7 sphinx-build --version
6161
====================== ================= ========================================
6262

6363
.. [#f1] Sphinx è necessario solo per produrre la documentazione del Kernel

Documentation/translations/zh_CN/doc-guide/sphinx.rst

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ reStructuredText文件可能包含包含来自源文件的结构化文档注释
2626
安装Sphinx
2727
==========
2828

29-
Documentation/ 下的ReST文件现在使用sphinx1.3或更高版本构建
29+
Documentation/ 下的ReST文件现在使用sphinx1.7或更高版本构建
3030

3131
这有一个脚本可以检查Sphinx的依赖项。更多详细信息见
3232
:ref:`sphinx-pre-install_zh` 。
@@ -40,22 +40,19 @@ Documentation/ 下的ReST文件现在使用sphinx1.3或更高版本构建。
4040

4141
.. note::
4242

43-
#) 低于1.5版本的Sphinx无法与Python的0.13.1或更高版本docutils一起正常工作。
44-
如果您想使用这些版本,那么应该运行 ``pip install 'docutils==0.12'`` 。
45-
4643
#) html输出建议使用RTD主题。根据Sphinx版本的不同,它应该用
4744
``pip install sphinx_rtd_theme`` 单独安装。
4845

4946
#) 一些ReST页面包含数学表达式。由于Sphinx的工作方式,这些表达式是使用 LaTeX
5047
编写的。它需要安装amsfonts和amsmath宏包,以便显示。
5148

52-
总之,如您要安装Sphinx 1.7.9版本,应执行::
49+
总之,如您要安装Sphinx 2.4.4版本,应执行::
5350

54-
$ virtualenv sphinx_1.7.9
55-
$ . sphinx_1.7.9/bin/activate
56-
(sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt
51+
$ virtualenv sphinx_2.4.4
52+
$ . sphinx_2.4.4/bin/activate
53+
(sphinx_2.4.4) $ pip install -r Documentation/sphinx/requirements.txt
5754

58-
在运行 ``. sphinx_1.7.9/bin/activate`` 之后,提示符将变化,以指示您正在使用新
55+
在运行 ``. sphinx_2.4.4/bin/activate`` 之后,提示符将变化,以指示您正在使用新
5956
环境。如果您打开了一个新的shell,那么在构建文档之前,您需要重新运行此命令以再
6057
次进入虚拟环境中。
6158

@@ -71,7 +68,7 @@ Documentation/ 下的ReST文件现在使用sphinx1.3或更高版本构建。
7168
PDF和LaTeX构建
7269
--------------
7370

74-
目前只有Sphinx 1.4及更高版本才支持这种构建。
71+
目前只有Sphinx 2.4及更高版本才支持这种构建。
7572

7673
对于PDF和LaTeX输出,还需要 ``XeLaTeX`` 3.14159265版本。(译注:此版本号真实
7774
存在)
@@ -93,8 +90,8 @@ PDF和LaTeX构建
9390
You should run:
9491

9592
sudo dnf install -y texlive-luatex85
96-
/usr/bin/virtualenv sphinx_1.7.9
97-
. sphinx_1.7.9/bin/activate
93+
/usr/bin/virtualenv sphinx_2.4.4
94+
. sphinx_2.4.4/bin/activate
9895
pip install -r Documentation/sphinx/requirements.txt
9996

10097
Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.

0 commit comments

Comments
 (0)