Use breathe-apidoc

This commit is contained in:
Florian Märkl 2019-02-08 17:34:46 +01:00 committed by xarkes
parent 2aacf88031
commit 321ca89f25
6 changed files with 15 additions and 7 deletions

1
docs-ref/.gitignore vendored
View File

@ -1,2 +1,3 @@
/doxygen-out
/build
/source/api

View File

@ -16,4 +16,6 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
doxygen
breathe-apidoc -g class,interface,struct,union -f -o source/api doxygen-out/xml/
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

7
docs-ref/source/api.rst Normal file
View File

@ -0,0 +1,7 @@
API
===========
.. toctree::
:glob:
api/*

View File

@ -71,6 +71,7 @@ pygments_style = None
breathe_projects = { "cutter": "../doxygen-out/xml" }
breathe_default_project = "cutter"
breathe_default_members = ('members', 'undoc-members')
# -- Options for HTML output -------------------------------------------------

View File

@ -9,8 +9,10 @@ Welcome to Cutter's documentation!
.. toctree::
:maxdepth: 2
:caption: Contents:
:glob:
*
reference.rst
Indices and tables

View File

@ -1,5 +0,0 @@
Reference
==================================
.. doxygenindex::