Use breathe + doxygen for API documentation.

This commit is contained in:
Victor Zverovich
2012-12-29 09:27:26 -08:00
parent 4762a8afd0
commit 5ec28a4914
4 changed files with 1270 additions and 23 deletions
+1
View File
@@ -1,4 +1,5 @@
add_custom_command(OUTPUT html/index.html
COMMAND doxygen
COMMAND sphinx-build -b html . ../html
DEPENDS conf.py index.rst)
add_custom_target(doc DEPENDS html/index.html)
+1231
View File
File diff suppressed because it is too large Load Diff
+7 -3
View File
@@ -25,10 +25,14 @@ import sys, os
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.ifconfig']
extensions = ['sphinx.ext.ifconfig', 'breathe']
breathe_projects = { "format": "doxyxml" }
breathe_default_project = "format"
breathe_domain_by_extension = {"h" : "cpp"}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['-templates']
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@@ -120,7 +124,7 @@ html_theme = 'sphinxdoc'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['-static']
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.