mirror of
https://github.com/rizinorg/cutter.git
synced 2025-01-31 08:37:26 +00:00
Use breathe-apidoc
This commit is contained in:
parent
2aacf88031
commit
321ca89f25
1
docs-ref/.gitignore
vendored
1
docs-ref/.gitignore
vendored
@ -1,2 +1,3 @@
|
|||||||
/doxygen-out
|
/doxygen-out
|
||||||
/build
|
/build
|
||||||
|
/source/api
|
||||||
|
@ -16,4 +16,6 @@ help:
|
|||||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
%: Makefile
|
%: 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
7
docs-ref/source/api.rst
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
API
|
||||||
|
===========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
|
||||||
|
api/*
|
@ -71,6 +71,7 @@ pygments_style = None
|
|||||||
|
|
||||||
breathe_projects = { "cutter": "../doxygen-out/xml" }
|
breathe_projects = { "cutter": "../doxygen-out/xml" }
|
||||||
breathe_default_project = "cutter"
|
breathe_default_project = "cutter"
|
||||||
|
breathe_default_members = ('members', 'undoc-members')
|
||||||
|
|
||||||
# -- Options for HTML output -------------------------------------------------
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
|
||||||
|
@ -9,8 +9,10 @@ Welcome to Cutter's documentation!
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Contents:
|
:caption: Contents:
|
||||||
|
:glob:
|
||||||
|
|
||||||
|
*
|
||||||
|
|
||||||
reference.rst
|
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
@ -1,5 +0,0 @@
|
|||||||
|
|
||||||
Reference
|
|
||||||
==================================
|
|
||||||
|
|
||||||
.. doxygenindex::
|
|
Loading…
Reference in New Issue
Block a user