DPDK patches and discussions
 help / color / mirror / Atom feed
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Cc: John McNamara <john.mcnamara@intel.com>
Subject: [dpdk-dev] [PATCH v1] doc: update sphinx installation instructions
Date: Sun, 17 Jul 2016 14:19:08 +0100	[thread overview]
Message-ID: <1468761548-1769-1-git-send-email-john.mcnamara@intel.com> (raw)

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 <john.mcnamara@intel.com>
---
 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 <http://sphinx-doc.org/tutorial.html>`_.
 
@@ -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 <http://www.tug.org/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

             reply	other threads:[~2016-07-17 13:19 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-07-17 13:19 John McNamara [this message]
2016-07-22 17:50 ` Thomas Monjalon

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=1468761548-1769-1-git-send-email-john.mcnamara@intel.com \
    --to=john.mcnamara@intel.com \
    --cc=dev@dpdk.org \
    /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;
as well as URLs for NNTP newsgroup(s).