Out-of-tree doc builds rely on extract__content.py to copy needed
content from the source folders to the build folders. To minimize what's
copied, all the reST files are copied plus files referenced by the reST
files. The extract_content.py script does a pattern match scan for
directives that reference other files (e.g., .. image::) and copies the
referenced file. It's not a smart parser though and doesn't ignore
directives in comments or in code-blocks. Rather than teaching the
script how to properly parse reST files, we'll just change the example
(in a code-block) to reference an existing image.
Fixes: #12621
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Add information about image size recommendations, and add some more
details about other reST features such as tables. Also added a flow
picture to the documentation generation doc.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
With the new theme we are able to have more section in the top level.
Move things around and expose the most important sections in the top
table of content.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
The collaboration content files have been placed in three folders. One
for communication, one for code collaboration and one for documentation
collaboration. This change only moves and renames the files. The
cross-references and file paths within the files have NOT ben change.
That is comming on the next change.
Change-Id: Ic09a51878ab432561bc394a4464570cc51a28d69
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
BSP terminology is obsolete; it has been supplanted by platforms and
platform configurations.
Change-Id: I105c7259e3eee6b0a0f67743d2b6b10ffb1db16f
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Added a asterisk in front of every line of the comments to fully comply
with the Javadoc style. Updated all cross-references to comply with the
new style. Added a note indicating explicitly that enums are to be
documented just as structs.
Change-Id: If017e14e3e478ec28befb5c1fcae92090f91c32e
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The guidelines contain how to tag content using the ReST markup employed
by Sphinx. Only the project specific rules are supplied. The general
syntax is provided by the Sphinx documentation. Examples and templates
are provided to make creating documentation easier.
Change-Id: If97e1f01de5d4f3de4cad82b7b35279a199433bf
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The style guidelines are mandatory patterns of writing designed to ease
the creation of documentation for the Zephyr project. All authors, which
includes the developers, must adhere to the style guide.
More detailed information, including examples, will be added shortly.
Change-Id: I198e5fe90b279560a60c028260b1fc8c972d322a
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The guidelines include information regarding: lists, modular writing,
notices, parallelism and simple English.
Also includes the capitalization, punctuation and spelling conventions
for the project.
Change-Id: I754f492db41dc5cc2432d03441b0526603b043e6
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
David B. Kinder