summaryrefslogtreecommitdiffstats
path: root/Documentation/doc-guide
diff options
context:
space:
mode:
authorJoel Nider <joeln@il.ibm.com>2019-01-14 02:14:59 -0500
committerJonathan Corbet <corbet@lwn.net>2019-01-14 19:36:53 -0500
commit4d01460ec9a454a9b536fd4e050f61389c381d9e (patch)
tree2401fa432abe78347d60c3de15552f2de58f7cfa /Documentation/doc-guide
parent80a76c7261d5c3a21eca3dacd6f10f9553c08244 (diff)
docs-rst: doc-guide: Minor grammar fixes
While using this guide to learn the new documentation method, I saw a few phrases that I felt could be improved. These small changes improve the grammar and choice of words to further enhance the installation instructions. Signed-off-by: Joel Nider <joeln@il.ibm.com> Acked-by: Mike Rapoport <rppt@linux.ibm.com> Acked-by: Matthew Wilcox <willy@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
-rw-r--r--Documentation/doc-guide/sphinx.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index 02605ee1d876..c039224b404e 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -27,8 +27,8 @@ Sphinx Install
27============== 27==============
28 28
29The ReST markups currently used by the Documentation/ files are meant to be 29The ReST markups currently used by the Documentation/ files are meant to be
30built with ``Sphinx`` version 1.3 or upper. If you're desiring to build 30built with ``Sphinx`` version 1.3 or higher. If you desire to build
31PDF outputs, it is recommended to use version 1.4.6 or upper. 31PDF output, it is recommended to use version 1.4.6 or higher.
32 32
33There's a script that checks for the Sphinx requirements. Please see 33There's a script that checks for the Sphinx requirements. Please see
34:ref:`sphinx-pre-install` for further details. 34:ref:`sphinx-pre-install` for further details.
@@ -37,15 +37,15 @@ Most distributions are shipped with Sphinx, but its toolchain is fragile,
37and it is not uncommon that upgrading it or some other Python packages 37and it is not uncommon that upgrading it or some other Python packages
38on your machine would cause the documentation build to break. 38on your machine would cause the documentation build to break.
39 39
40A way to get rid of that is to use a different version than the one shipped 40A way to avoid that is to use a different version than the one shipped
41on your distributions. In order to do that, it is recommended to install 41with your distributions. In order to do so, it is recommended to install
42Sphinx inside a virtual environment, using ``virtualenv-3`` 42Sphinx inside a virtual environment, using ``virtualenv-3``
43or ``virtualenv``, depending on how your distribution packaged Python 3. 43or ``virtualenv``, depending on how your distribution packaged Python 3.
44 44
45.. note:: 45.. note::
46 46
47 #) Sphinx versions below 1.5 don't work properly with Python's 47 #) Sphinx versions below 1.5 don't work properly with Python's
48 docutils version 0.13.1 or upper. So, if you're willing to use 48 docutils version 0.13.1 or higher. So, if you're willing to use
49 those versions, you should run ``pip install 'docutils==0.12'``. 49 those versions, you should run ``pip install 'docutils==0.12'``.
50 50
51 #) It is recommended to use the RTD theme for html output. Depending 51 #) It is recommended to use the RTD theme for html output. Depending
@@ -82,7 +82,7 @@ output.
82PDF and LaTeX builds 82PDF and LaTeX builds
83-------------------- 83--------------------
84 84
85Such builds are currently supported only with Sphinx versions 1.4 and upper. 85Such builds are currently supported only with Sphinx versions 1.4 and higher.
86 86
87For PDF and LaTeX output, you'll also need ``XeLaTeX`` version 3.14159265. 87For PDF and LaTeX output, you'll also need ``XeLaTeX`` version 3.14159265.
88 88