From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
SeongJae Park <sj38.park@gmail.com>,
Markus Heiser <markus.heiser@darmarit.de>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Masahiro Yamada <yamada.masahiro@socionext.com>,
Max Filippov <jcmvbkbc@gmail.com>
Subject: [PATCH v2 2/6] docs-rst: move Sphinx install instructions to sphinx.rst
Date: Fri, 14 Jul 2017 13:41:17 -0300 [thread overview]
Message-ID: <b7090781e63bbb9b54fddd6b90bc6110fa0bad89.1500050366.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1500050366.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1500050366.git.mchehab@s-opensource.com>
The toolchain used by Sphinx is somewhat complex, and installing
it should be part of the doc-guide.
Move it out of changes.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/doc-guide/sphinx.rst | 17 +++++++++++++++++
Documentation/process/changes.rst | 14 ++------------
2 files changed, 19 insertions(+), 12 deletions(-)
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index 84e8e8a9cbdb..1ee109b19322 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -19,6 +19,23 @@ Finally, there are thousands of plain text documentation files scattered around
``Documentation``. Some of these will likely be converted to reStructuredText
over time, but the bulk of them will remain in plain text.
+.. _sphinx_install:
+
+Sphinx Install
+==============
+
+The ReST markups currently used by the Documentation/ files are meant to be
+built with ``Sphinx`` version 1.3 or upper. If you're desiring to build
+PDF outputs, it is recommended to use version 1.4.6 or upper.
+
+.. note::
+
+ Please notice that, for PDF and LaTeX output, you'll also need ``XeLaTeX``
+ version 3.14159265. Depending on the distribution, you may also need to
+ install a series of ``texlive`` packages that provide the minimal set of
+ functionalities required for ``XeLaTex`` to work. For PDF output you'll also
+ need ``convert(1)`` from ImageMagick (https://www.imagemagick.org).
+
Sphinx Build
============
diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index ceddf1d1e646..560beaef5a7c 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -309,18 +309,8 @@ Kernel documentation
Sphinx
------
-The ReST markups currently used by the Documentation/ files are meant to be
-built with ``Sphinx`` version 1.3 or upper. If you're desiring to build
-PDF outputs, it is recommended to use version 1.4.6 or upper.
-
-.. note::
-
- Please notice that, for PDF and LaTeX output, you'll also need ``XeLaTeX``
- version 3.14159265. Depending on the distribution, you may also need to
- install a series of ``texlive`` packages that provide the minimal set of
- functionalities required for ``XeLaTex`` to work. For PDF output you'll also
- need ``convert(1)`` from ImageMagick (https://www.imagemagick.org).
-
+Please see :ref:`sphinx_install` in ``Documentation/doc-guide/sphinx.rst``
+for details about Sphinx requirements.
Getting updated software
========================
--
2.13.0
next prev parent reply other threads:[~2017-07-14 16:41 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-14 16:41 [PATCH v2 0/6] Better document Sphinx install instructions Mauro Carvalho Chehab
2017-07-14 16:41 ` [PATCH v2 1/6] changes.rst: Update Sphinx minimal requirements Mauro Carvalho Chehab
2017-07-14 16:41 ` Mauro Carvalho Chehab [this message]
2017-07-14 16:41 ` [PATCH v2 3/6] sphinx.rst: explain the usage of virtual environment Mauro Carvalho Chehab
2017-07-14 16:41 ` [PATCH v2 4/6] sphinx.rst: fix unknown reference Mauro Carvalho Chehab
2017-07-14 16:41 ` [PATCH v2 5/6] sphinx.rst: describe the install requirements for kfigure Mauro Carvalho Chehab
2017-07-14 16:41 ` [PATCH v2 6/6] sphinx.rst: better organize the documentation about PDF build Mauro Carvalho Chehab
2017-07-17 19:40 ` [PATCH v2 0/6] Better document Sphinx install instructions Jonathan Corbet
2017-07-17 21:23 ` Mauro Carvalho Chehab
2017-07-17 21:26 ` Jonathan Corbet
2017-07-17 21:55 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b7090781e63bbb9b54fddd6b90bc6110fa0bad89.1500050366.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=daniel.vetter@ffwll.ch \
--cc=gregkh@linuxfoundation.org \
--cc=jcmvbkbc@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@infradead.org \
--cc=sj38.park@gmail.com \
--cc=yamada.masahiro@socionext.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®