From 321ca89f252ada031b3c181e659d04e2a22c790b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20M=C3=A4rkl?= Date: Fri, 8 Feb 2019 17:34:46 +0100 Subject: [PATCH] Use breathe-apidoc --- docs-ref/.gitignore | 1 + docs-ref/Makefile | 4 +++- docs-ref/source/api.rst | 7 +++++++ docs-ref/source/conf.py | 1 + docs-ref/source/index.rst | 4 +++- docs-ref/source/reference.rst | 5 ----- 6 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 docs-ref/source/api.rst delete mode 100644 docs-ref/source/reference.rst diff --git a/docs-ref/.gitignore b/docs-ref/.gitignore index 36756c21..5a982a1a 100644 --- a/docs-ref/.gitignore +++ b/docs-ref/.gitignore @@ -1,2 +1,3 @@ /doxygen-out /build +/source/api diff --git a/docs-ref/Makefile b/docs-ref/Makefile index 69fe55ec..c26702d4 100644 --- a/docs-ref/Makefile +++ b/docs-ref/Makefile @@ -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) \ No newline at end of file + doxygen + breathe-apidoc -g class,interface,struct,union -f -o source/api doxygen-out/xml/ + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs-ref/source/api.rst b/docs-ref/source/api.rst new file mode 100644 index 00000000..91894747 --- /dev/null +++ b/docs-ref/source/api.rst @@ -0,0 +1,7 @@ +API +=========== + +.. toctree:: + :glob: + + api/* diff --git a/docs-ref/source/conf.py b/docs-ref/source/conf.py index a2a47d58..357978ac 100644 --- a/docs-ref/source/conf.py +++ b/docs-ref/source/conf.py @@ -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 ------------------------------------------------- diff --git a/docs-ref/source/index.rst b/docs-ref/source/index.rst index 89d84355..ff6a92de 100644 --- a/docs-ref/source/index.rst +++ b/docs-ref/source/index.rst @@ -9,8 +9,10 @@ Welcome to Cutter's documentation! .. toctree:: :maxdepth: 2 :caption: Contents: + :glob: + + * - reference.rst Indices and tables diff --git a/docs-ref/source/reference.rst b/docs-ref/source/reference.rst deleted file mode 100644 index 6246fc95..00000000 --- a/docs-ref/source/reference.rst +++ /dev/null @@ -1,5 +0,0 @@ - -Reference -================================== - -.. doxygenindex::