From 7be2368bbea78acb77f6472281a858d90096b26e Mon Sep 17 00:00:00 2001 From: crouzet Date: Tue, 12 Feb 2019 11:34:04 +0100 Subject: [PATCH] suppression de la doc api autodoc --- doc/Makefile | 14 +++----------- doc/src/commands/apidoc/modules.rst | 7 ------- doc/src/conf.py | 10 +--------- doc/src/index.rst | 8 -------- 4 files changed, 4 insertions(+), 35 deletions(-) delete mode 100644 doc/src/commands/apidoc/modules.rst diff --git a/doc/Makefile b/doc/Makefile index 331eebc..da3be1c 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -37,10 +37,10 @@ help: clean: -rm -rf $(BUILDDIR)/* -html: apidoc +html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + @echo "Build finished. The HTML pages are available in $(BUILDDIR)/html/index.html" clean-html: make clean @@ -108,6 +108,7 @@ latexpdf: make -C $(BUILDDIR)/latex all-pdf $(SILENT) @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + clean-pdf: make clean make latexpdf @@ -138,13 +139,4 @@ doctest: @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." -# splitin many files rst -#apidoc: -# @sphinx-apidoc --separate -o src/apidoc_src ../src -# @sphinx-apidoc --separate -o src/apidoc_commands ../commands - -apidoc: - @sphinx-apidoc -o src/apidoc_src ../src - @sphinx-apidoc -o src/apidoc_commands ../commands - diff --git a/doc/src/commands/apidoc/modules.rst b/doc/src/commands/apidoc/modules.rst deleted file mode 100644 index e9ff8ac..0000000 --- a/doc/src/commands/apidoc/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -src -=== - -.. toctree:: - :maxdepth: 4 - - src diff --git a/doc/src/conf.py b/doc/src/conf.py index c315a0e..aacab42 100644 --- a/doc/src/conf.py +++ b/doc/src/conf.py @@ -14,14 +14,6 @@ import sys import os -# Append source folder to path in order to enable autodoc -currentPath = os.path.dirname(__file__) -print("sphinx on file %s" % __file__) -dirAutodoc = os.path.realpath(os.path.join(currentPath, '..', '..')) -print("autodoc on dir %s" % dirAutodoc) -sys.path.append(dirAutodoc) -sys.path.append(dirAutodoc + "/commands") - # https://stackoverflow.com/questions/23462494/how-to-add-a-custom-css-file-to-sphinx # this needs realpath(custom), cause problem on relocated git clone, @@ -43,7 +35,7 @@ sys.path.append(dirAutodoc + "/commands") # 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.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode'] +extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode'] # do not use rst_prolog please use doc/rst_prolog.rst and '.. include:: ../rst_prolog.rst' # https://github.com/sphinx-doc/sphinx/issues/2445 diff --git a/doc/src/index.rst b/doc/src/index.rst index 07c305d..5b2a111 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -65,14 +65,6 @@ Developer documentation Add a command -Code documentation -================== - -.. toctree:: - :maxdepth: 1 - - SAT modules - Release Notes ============= -- 2.39.2