michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add doc writing guides w/common usages

Browse source 
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>
This commit is contained in:
David B. Kinder 2018-05-04 16:31:05 -07:00 • committed by Anas Nashif
commit 486c5a54e5
6 changed files with 415 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/templates/sample.tmpl vendored
View file

@ -24,6 +24,10 @@ Building and Running
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]