From c08565dad4f3d0a16f766e856f8af9642305d133 Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Fri, 17 Jan 2020 16:06:38 +0100 Subject: [PATCH] doc: Link to Documentation Generation from Documentation Guidelines Gerson Fernando Budke missed the Documentation Generation page. Nice to link to it from the Documentation Guidelines page, in case people are looking for documentation information and find it first. Maybe the two pages could be put under a common Documentation section too, though it's nice to have Documentation Generation clearly visible in the top-level User Guides index. Co-authored-by: Gerson Fernando Budke Signed-off-by: Ulf Magnusson --- doc/guides/documentation/index.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/guides/documentation/index.rst b/doc/guides/documentation/index.rst index ac9b9713897..eb17b5773ce 100644 --- a/doc/guides/documentation/index.rst +++ b/doc/guides/documentation/index.rst @@ -3,6 +3,10 @@ Documentation Guidelines ######################## +.. note:: + + For instructions on building the documentation, see :ref:`zephyr_doc`. + Zephyr Project content is written using the `reStructuredText`_ markup language (.rst file extension) with Sphinx extensions, and processed using Sphinx to create a formatted standalone website. Developers can @@ -602,3 +606,5 @@ Put your right hand in See the :zephyr_raw:`doc/getting_started/index.rst` source file and compare with the :ref:`getting_started` to see a full example. As implemented, only one set of numbered steps is intended per document. + +For instructions on building the documentation, see :ref:`zephyr_doc`.