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-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>

authored by

Joel Nider and committed by
Jonathan Corbet 4d01460e 80a76c72

+6 -6
+6 -6
Documentation/doc-guide/sphinx.rst
··· 27 27 ============== 28 28 29 29 The ReST markups currently used by the Documentation/ files are meant to be 30 - built with ``Sphinx`` version 1.3 or upper. If you're desiring to build 31 - PDF outputs, it is recommended to use version 1.4.6 or upper. 30 + built with ``Sphinx`` version 1.3 or higher. If you desire to build 31 + PDF output, it is recommended to use version 1.4.6 or higher. 32 32 33 33 There's a script that checks for the Sphinx requirements. Please see 34 34 :ref:`sphinx-pre-install` for further details. ··· 37 37 and it is not uncommon that upgrading it or some other Python packages 38 38 on your machine would cause the documentation build to break. 39 39 40 - A way to get rid of that is to use a different version than the one shipped 41 - on your distributions. In order to do that, it is recommended to install 40 + A way to avoid that is to use a different version than the one shipped 41 + with your distributions. In order to do so, it is recommended to install 42 42 Sphinx inside a virtual environment, using ``virtualenv-3`` 43 43 or ``virtualenv``, depending on how your distribution packaged Python 3. 44 44 45 45 .. note:: 46 46 47 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 49 those versions, you should run ``pip install 'docutils==0.12'``. 50 50 51 51 #) It is recommended to use the RTD theme for html output. Depending ··· 82 82 PDF and LaTeX builds 83 83 -------------------- 84 84 85 - Such builds are currently supported only with Sphinx versions 1.4 and upper. 85 + Such builds are currently supported only with Sphinx versions 1.4 and higher. 86 86 87 87 For PDF and LaTeX output, you'll also need ``XeLaTeX`` version 3.14159265. 88 88