This website requires JavaScript.
Explore
Help
Sign In
mirrors
/
weston
Watch
1
Star
0
Fork
0
You've already forked weston
Code
Issues
Pull Requests
Packages
Projects
Releases
Wiki
Activity
b10c0e843d
weston
/
doc
/
sphinx
/
run_doxygen_sphinx.sh.in
3 lines
90 B
Bash
Raw
Normal View
History
Unescape
Escape
build: Add sphinx/breathe support for generating documentation This is adds basic configuration files for doxygen and for breathe, which is a doxygen-to-sphinx bridge that can document C symbols. Breathe is configured with default project 'weston' and implicitly adds :members: and :undoc-members: to breathe configuration options. This allows a shorter way to call breathe directives without the need specify the project and also to display implicitly all the members, documented or not. A 'docs' run_target to force the docs to be re-built has been added. Initially (the first time the build system is ran) the documentation will automatically be built, but later re-builds will require the use of the 'docs' target. This avoid further delays in building weston but in the same time allows the possiblity to update/improve the documentation bits to those who want that. Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
2019-06-14 12:41:02 +03:00
#!/bin/sh
doc/sphinx: Force sphinx to re-build everything as to avoid stale docs With the introduction of the 'docs' target we make sure that we always build the documentation, but currently breathe is unaware of the fact that the doxygen XML database was changed in between runs. It is obvious when changing only source code not rST bits. This patch makes sphinx ignore the saved environment and always rebuild the docs. Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
2019-06-28 13:16:12 +03:00
@DOXYGEN_CMD@ @DOXYGEN_CONF@
&&
@SPHINX_CMD@ -E -W -q -j auto @SRCDIR@ @OUTDIR@
Reference in New Issue
Copy Permalink