patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

doc: Add reference in toplevel README.rst to install_py_requirements

Browse source 
In the section 'Documentation presentation theme' put a reference to
'install_py_requirements' section in the getting start guide.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Kumar Gala 2020-02-07 18:55:19 -06:00 committed by Johan Hedberg
parent 46db22c6c8
commit af16c3b3e7
2 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/README.rst
View file

@ -114,12 +114,11 @@ Documentation presentation theme
********************************
Sphinx supports easy customization of the generated documentation
appearance through the use of themes. Replace the theme files and do
appearance through the use of themes. Replace the theme files and do
another ``make htmldocs`` and the output layout and style is changed.
The ``read-the-docs`` theme is installed as part of the
``requirements.txt`` list above, and will be used if it's available, for
local doc generation.
:ref:`install_py_requirements` step you took in the getting started
guide.
Running the documentation processors
************************************

2
doc/getting_started/index.rst
View file

@ -246,6 +246,8 @@ directory using west:
cd zephyrproject
west update
.. _install_py_requirements:
.. rst-class:: numbered-step
Install needed Python packages