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
make -C $(BUILDDIR)/latex all-pdf $(SILENT)
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
clean-pdf:
make clean
make latexpdf
@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
-
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,
# 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