zephyr/doc/contribute/documentation/index.rst

.. _documentation:

Documentation
#############

.. toctree::
   :maxdepth: 1

   guidelines.rst
   generation.rst
doc: consolidate documentation sections Consolidate all content realted to documentation. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2022-04-05 22:31:40 +08:00			`.. _documentation:`
doc: add doc writing guides w/common usages I've collected some of the common issues encountered with doc reviews into a new contributing document, and included use of the Zephyr-specific extension for generating code building examples. Updated conf.py and created an external list of substitutions making it easier to manage them without editing the sphinx conf file (and documented this). Tweaked the comments in the application.py extension python code to render better in the generated doc that extracts these comments (keeps the documentation in the python code too to ease maintenance when updates are made). Updated the sample template to mention use of this sphinx extension. fixes: #6831 fixes: #6811 Signed-off-by: David B. Kinder <david.b.kinder@intel.com> 2018-05-05 07:31:05 +08:00
doc: consolidate documentation sections Consolidate all content realted to documentation. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2022-04-05 22:31:40 +08:00			`Documentation`
			`#############`
doc: add doc writing guides w/common usages I've collected some of the common issues encountered with doc reviews into a new contributing document, and included use of the Zephyr-specific extension for generating code building examples. Updated conf.py and created an external list of substitutions making it easier to manage them without editing the sphinx conf file (and documented this). Tweaked the comments in the application.py extension python code to render better in the generated doc that extracts these comments (keeps the documentation in the python code too to ease maintenance when updates are made). Updated the sample template to mention use of this sphinx extension. fixes: #6831 fixes: #6811 Signed-off-by: David B. Kinder <david.b.kinder@intel.com> 2018-05-05 07:31:05 +08:00
doc: consolidate documentation sections Consolidate all content realted to documentation. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2022-04-05 22:31:40 +08:00			`.. toctree::`
			`:maxdepth: 1`
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 <nandojve@gmail.com> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no> 2020-01-17 23:06:38 +08:00
doc: consolidate documentation sections Consolidate all content realted to documentation. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2022-04-05 22:31:40 +08:00			`guidelines.rst`
			`generation.rst`