Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753991AbdFSLYU (ORCPT ); Mon, 19 Jun 2017 07:24:20 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:44135 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1753711AbdFSLYS (ORCPT ); Mon, 19 Jun 2017 07:24:18 -0400 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Greg Kroah-Hartman , SeongJae Park , Markus Heiser , Masahiro Yamada , Max Filippov Subject: [PATCH] changes.rst: explain the usage of virtual environment Date: Mon, 19 Jun 2017 08:24:10 -0300 Message-Id: <736d4f4128feaf09f0de91e665dd0666ffa07a18.1497870046.git.mchehab@s-opensource.com> X-Mailer: git-send-email 2.9.4 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1567 Lines: 42 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 --- 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