mainnika
/
weston
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6946 Commits
1 Branch
0 Tags
14 MiB
Tag: Branch: Tree: 2619bfe420
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '2619bfe420'
${ noResults }
weston/doc/sphinx/run_doxygen_sphinx.sh.in

3 lines
90 B
Raw Normal View History Unescape

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>
6 years ago
#!/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>
5 years ago
@DOXYGEN_CMD@ @DOXYGEN_CONF@ && @SPHINX_CMD@ -E -W -q -j auto @SRCDIR@ @OUTDIR@