Salome HOME
suppression de la doc api autodoc
authorcrouzet <nicolas.crouzet@cea.fr>
Tue, 12 Feb 2019 10:34:04 +0000 (11:34 +0100)
committercrouzet <nicolas.crouzet@cea.fr>
Tue, 12 Feb 2019 10:34:04 +0000 (11:34 +0100)
doc/Makefile
doc/src/commands/apidoc/modules.rst [deleted file]
doc/src/conf.py
doc/src/index.rst

index 331eebcf413e7960e80521d332f09f9178a4b84e..da3be1c69d1521f6ea634b64569ae30c41375ad5 100644 (file)
@@ -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 (file)
index e9ff8ac..0000000
+++ /dev/null
@@ -1,7 +0,0 @@
-src
-===
-
-.. toctree::
-   :maxdepth: 4
-
-   src
index c315a0e2564b258a2657d2411cb8fa22946fbe06..aacab42df1b4373e1794497af8755dfb5041cb29 100644 (file)
 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
index 07c305d0afbd8eba46a4601c0966d4b122b603b4..5b2a111a2fbd7cdace8a1d377bffe3909952c9e0 100644 (file)
@@ -65,14 +65,6 @@ Developer documentation
    Add a command <write_command>
 
 
-Code documentation
-==================
-.. toctree::
-   :maxdepth: 1
-
-   SAT modules <commands/apidoc/modules.rst>
-
 
 Release Notes
 =============