From af16c3b3e76bc09e37bc879c4347ec92dc955b8a Mon Sep 17 00:00:00 2001 From: Kumar Gala Date: Fri, 7 Feb 2020 18:55:19 -0600 Subject: [PATCH] doc: Add reference in toplevel README.rst to install_py_requirements MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In the section 'Documentation presentation theme' put a reference to 'install_py_requirements' section in the getting start guide. Signed-off-by: Kumar Gala Signed-off-by: Martí Bolívar --- doc/README.rst | 7 +++---- doc/getting_started/index.rst | 2 ++ 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/README.rst b/doc/README.rst index 1e3e130072c..0c4cc8d9dbd 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -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 ************************************ diff --git a/doc/getting_started/index.rst b/doc/getting_started/index.rst index caff3edbfa7..d56b938c35a 100644 --- a/doc/getting_started/index.rst +++ b/doc/getting_started/index.rst @@ -246,6 +246,8 @@ directory using west: cd zephyrproject west update +.. _install_py_requirements: + .. rst-class:: numbered-step Install needed Python packages