michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Link to Documentation Generation from Documentation Guidelines

Browse source 
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 <nandojve@gmail.com>
Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
This commit is contained in:
Ulf Magnusson 2020-01-17 16:06:38 +01:00 • committed by Anas Nashif
commit c08565dad4
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/guides/documentation/index.rst
View file

@ -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`.