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>
20 lines
633 B
Plaintext
20 lines
633 B
Plaintext
.. |br| raw:: html .. force a line break in HTML output (blank lines needed here)
|
|
|
|
<br />
|
|
|
|
.. These are replacement strings for non-ASCII characters used within the project
|
|
using the same name as the html entity names (e.g., ©) for that character
|
|
|
|
.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN
|
|
:ltrim:
|
|
.. |trade| unicode:: U+02122 .. TRADEMARK SIGN
|
|
:ltrim:
|
|
.. |reg| unicode:: U+000AE .. REGISTERED TRADEMARK SIGN
|
|
:ltrim:
|
|
.. |deg| unicode:: U+000B0 .. DEGREE SIGN
|
|
:ltrim:
|
|
.. |plusminus| unicode:: U+000B1 .. PLUS-MINUS SIGN
|
|
:rtrim:
|
|
.. |micro| unicode:: U+000B5 .. MICRO SIGN
|
|
:rtrim:
|