From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id DA719475E for ; Sun, 17 Jul 2016 15:19:11 +0200 (CEST) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga102.fm.intel.com with ESMTP; 17 Jul 2016 06:19:10 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.28,378,1464678000"; d="scan'208";a="1023384057" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by fmsmga002.fm.intel.com with ESMTP; 17 Jul 2016 06:19:10 -0700 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id u6HDJ90T029843; Sun, 17 Jul 2016 14:19:09 +0100 Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id u6HDJ9t6001877; Sun, 17 Jul 2016 14:19:09 +0100 Received: (from jmcnam2@localhost) by sivswdev02.ir.intel.com with id u6HDJ9OC001873; Sun, 17 Jul 2016 14:19:09 +0100 From: John McNamara To: dev@dpdk.org Cc: John McNamara Date: Sun, 17 Jul 2016 14:19:08 +0100 Message-Id: <1468761548-1769-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 Subject: [dpdk-dev] [PATCH v1] doc: update sphinx installation instructions X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 17 Jul 2016 13:19:12 -0000 Update the Sphinx installation instructions in the documentation contributors guide to reflect the fact that in the 1.4+ versions of Sphinx the ReadTheDocs theme must also be installed. Previously, in version 1.3.x, it was installed by default. Also change 'yum' to 'dnf' for package installations. Signed-off-by: John McNamara --- doc/guides/contributing/documentation.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index ba5c4de..b2cc903 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -155,7 +155,7 @@ It can be installed as follows: sudo apt-get -y install doxygen # Red Hat/Fedora. - sudo yum -y install doxygen + sudo dnf -y install doxygen `Sphinx`_ is a Python documentation tool for converting RST files to Html or to PDF (via LaTeX). For full support with figure and table captioning the latest version of Sphinx can be installed as follows: @@ -165,10 +165,12 @@ For full support with figure and table captioning the latest version of Sphinx c # Ubuntu/Debian. sudo apt-get -y install python-pip sudo pip install --upgrade sphinx + sudo pip install --upgrade sphinx_rtd_theme # Red Hat/Fedora. - sudo yum -y install python-pip + sudo dnf -y install python-pip sudo pip install --upgrade sphinx + sudo pip install --upgrade sphinx_rtd_theme For further information on getting started with Sphinx see the `Sphinx Tutorial `_. @@ -186,7 +188,7 @@ It can be installed as follows: sudo apt-get -y install inkscape # Red Hat/Fedora. - sudo yum -y install inkscape + sudo dnf -y install inkscape `TexLive `_ is an installation package for Tex/LaTeX. It is used to generate the PDF versions of the documentation. @@ -198,7 +200,7 @@ The main required packages can be installed as follows: sudo apt-get -y install texlive-latex-extra # Red Hat/Fedora, selective install. - sudo yum -y install texlive-collection-latexextra + sudo dnf -y install texlive-collection-latexextra Build commands -- 2.7.4