michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add warning about sphinx errors

Browse source 
I committed a user error and edited a file named in the sphinx output
to correct an error. To my dismay later, I discovered my work had been
lost as that file is not versioned.

Warn the others.

Signed-off-by: Marti Bolivar <marti@foundries.io>
This commit is contained in:
Marti Bolivar 2018-10-16 08:47:52 -06:00 • committed by Anas Nashif
commit 27eb8d3db4
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
doc/README.rst
View file

@ -109,6 +109,17 @@ folder, here are the commands to generate the html content locally:
# To generate PDF output, run ninja on the generated build system:
ninja pdfdocs
.. warning::
The documentation build system creates copies in the build
directory of every .rst file used to generate the documentation,
along with dependencies referenced by those .rst files.
This means that Sphinx warnings and errors refer to the **copies**,
and **not the version-controlled original files in Zephyr**. Be
careful to make sure you don't accidentally edit the copy of the
file in an error message, as these changes will not be saved.
Depending on your development system, it will take up to 15 minutes to
collect and generate the HTML content. When done, you can view the HTML
output with your browser started at ``doc/_build/html/index.html`` and