486c5a54e5
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>
36 lines
997 B
Cheetah
36 lines
997 B
Cheetah
.. _descriptive_title_link_name:
|
|
|
|
[A Descriptive Title]
|
|
#####################
|
|
|
|
Overview
|
|
********
|
|
[A short description about the sample and what it does]
|
|
|
|
Requirements
|
|
************
|
|
[List of required software and hardware components. Provide pointers to
|
|
hardware components such as sensors and shields]
|
|
|
|
Wiring
|
|
******
|
|
[For simple projects, a description of how to wire the board for the demo. For
|
|
complex projects, provide a graphic with more details, preferably using
|
|
Fritzing or some other visualisation tools]
|
|
|
|
Building and Running
|
|
********************
|
|
[ How to build the sample and how to run it. Pointers to where to find the
|
|
sample in the source tree and how to configure it and run it for a specific
|
|
target platform]
|
|
|
|
[When showing code-blocks with sample build command instructions, use the
|
|
..zephyr-app-commands directive (see the doc guidelines) instead of a
|
|
hand-written code-block.]
|
|
|
|
References
|
|
**********
|
|
[ Links to external references such as datasheets or additional documentation]
|
|
|
|
|