michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: cmake must be re-run if adding/removing files

Browse source 
This is a consequence of the move to tracking each documentation
source file individually.

Signed-off-by: Marti Bolivar <marti@foundries.io>
This commit is contained in:
Marti Bolivar 2018-10-11 09:02:42 -06:00 • committed by Carles Cufí
commit b307be0382
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/README.rst
View file

@ -117,6 +117,10 @@ the PDF file is available at ``doc/_build/pdf/zephyr.pdf``.
If you want to build the documentation from scratch just delete the contents
of the build folder and run ``cmake`` and then ``ninja`` again.
.. note::
If you add or remove a file from the documentation, you need to re-run CMake.
On Unix platforms a convenience :file:`Makefile` at the root folder
of the Zephyr repository can be used to build the documentation directly from
there: