Skip to content

Commit

Permalink
doc: tweak doc build tools instructions
Browse files Browse the repository at this point in the history
need to use sudo -E (to get environment variables)

Signed-off-by: David B. Kinder <[email protected]>
  • Loading branch information
dbkinder authored and Anas Nashif committed May 19, 2017
1 parent 11baf5c commit 11d7449
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions doc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,14 @@ export the environment variables ``ZEPHYR_GCC_VARIANT`` and
Here are a set of commands to install the documentation generations tools on
Ubuntu:


.. code-block:: bash
$ sudo apt-get install python-pip
$ sudo -E apt-get install python-pip
$ pip install --upgrade pip
$ sudo apt-get install doxygen
$ sudo -E apt-get install doxygen
$ pip install sphinx==1.4.4
$ sudo -H pip install breathe
$ sudo -H pip install sphinx-rtd-theme
$ sudo -HE pip install breathe
$ sudo -HE pip install sphinx-rtd-theme
There is a known issue that causes docutils version 0.13 to fail with sphinx
1.4.4. Verify the version of docutils using:
Expand All @@ -89,7 +88,7 @@ the working version of docutils with:

.. code-block:: bash
$ sudo -H pip install docutils==0.12
$ sudo -HE pip install docutils==0.12
Running the Documentation Generators
Expand Down

0 comments on commit 11d7449

Please sign in to comment.