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>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
SeongJae Park <sj38.park@gmail.com>,
Markus Heiser <markus.heiser@darmarit.de>,
Masahiro Yamada <yamada.masahiro@socionext.com>,
Max Filippov <jcmvbkbc@gmail.com>
Subject: [PATCH] changes.rst: explain the usage of virtual environment
Date: Mon, 19 Jun 2017 08:24:10 -0300 [thread overview]
Message-ID: <736d4f4128feaf09f0de91e665dd0666ffa07a18.1497870046.git.mchehab@s-opensource.com> (raw)
As the Sphinx build seems very fragile, specially for
PDF output, add a notice about how to use it on a virtual
environment.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/process/changes.rst | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index 3aed751e0cb5..8a51f37bce4a 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -322,6 +322,24 @@ PDF outputs, it is recommended to use version 1.4.6.
functionalities required for ``XeLaTex`` to work. For PDF output you'll also
need ``convert(1)`` from ImageMagick (https://www.imagemagick.org).
+Most distributions are shipped with Sphinx, but sometimes you may need
+to use a version different than the one shipped. For those cases, you
+can use Sphinx on a virtual environment. For example, if you want to
+install the Python 3 Sphinx version 1.4.9, do::
+
+ $ virtualenv-3 sphinx_1.4
+ $ . sphinx_1.4/bin/activate
+ $ pip install 'Sphinx==1.4.9'
+
+.. note::
+
+ #) It is recommended to use the RTD theme for html output. Depending
+ on the version, it should be installed in separate,
+ with ``pip install sphinx_rtd_theme``.
+
+ #) The command ``. sphinx_1.4/bin/activate`` sets the environment to
+ use the virtual environment you just install. It should be called
+ when you start a new shell, before running ``make htmldocs``.
Getting updated software
========================
--
2.9.4
next reply other threads:[~2017-06-19 11:24 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-19 11:24 Mauro Carvalho Chehab [this message]
2017-06-19 13:08 ` Christoph Hellwig
2017-06-19 13:46 ` Jonathan Corbet
2017-06-19 14:11 ` Markus Heiser
2017-06-19 14:38 ` Mauro Carvalho Chehab
2017-06-19 15:13 ` Markus Heiser
2017-06-20 15:03 ` Markus Heiser
2017-06-19 14:21 ` 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=736d4f4128feaf09f0de91e665dd0666ffa07a18.1497870046.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--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®