diff options
| author | lns <matzeton@googlemail.com> | 2022-05-29 00:27:10 +0200 |
|---|---|---|
| committer | lns <matzeton@googlemail.com> | 2022-05-29 13:44:28 +0200 |
| commit | aa686a25939323e27054843f57ed1dffb10925e4 (patch) | |
| tree | 3f510389966658e749d341d394c313a8ad024288 /doc/Makefile | |
| parent | cfd23e88198716d8d5b3625a7da586536701349f (diff) | |
Use Doxygen to generate the API documentation.add/doxygen-gen
* Integrated Doxygen documentation into Sphinx
Signed-off-by: lns <matzeton@googlemail.com>
Diffstat (limited to 'doc/Makefile')
| -rw-r--r-- | doc/Makefile | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/Makefile b/doc/Makefile index 5394470d3..ccffc95f7 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -22,8 +22,8 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help help: @echo "Please use \`make <target>' where <target> is one of" - @echo " release to make standalone HTML files for ntop documentation release" - @echo " html to make standalone HTML files" + @echo " release to make standalone Doxygen/HTML files for ntop documentation release" + @echo " html to make standalone Doxygen/HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @@ -50,12 +50,15 @@ help: .PHONY: clean clean: - rm -rf $(BUILDDIR)/* - cd doxygen; make clean + rm -rf $(BUILDDIR)/* api doxygen .PHONY: html html: - cd doxygen; make + @test -r Doxyfile.cfg || { \ + echo 'Doxyfile.cfg does not exist; Please run $(realpath ..)/autogen.sh or $(realpath ..)/configure first.'; \ + false; \ + } + doxygen Doxyfile.cfg $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |