summaryrefslogtreecommitdiffstats
path: root/storage/maria/libmarias3/docs/include.am
diff options
context:
space:
mode:
Diffstat (limited to 'storage/maria/libmarias3/docs/include.am')
-rw-r--r--storage/maria/libmarias3/docs/include.am82
1 files changed, 82 insertions, 0 deletions
diff --git a/storage/maria/libmarias3/docs/include.am b/storage/maria/libmarias3/docs/include.am
new file mode 100644
index 00000000..1a9ef3f5
--- /dev/null
+++ b/storage/maria/libmarias3/docs/include.am
@@ -0,0 +1,82 @@
+# vim:ft=automake
+# included from Top Level Makefile.am
+# All paths should be given relative to the root
+
+# Makefile for Sphinx documentation
+#
+
+SPHINXOPTS = ${SPHINX_WARNINGS} -q
+PAPER =
+SPHINX_BUILDDIR = ${abs_srcdir}/docs
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -c $(top_builddir)/docs $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINX_BUILDDIR)
+
+.PHONY: clean-docs-check
+clean-docs-check:
+ -rm -rf docs/_build docs/doctrees man/.doctrees
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+man: docs/conf.py
+ @PYTHONPATH=$(SPHINX_BUILDDIR)/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man
+
+install-html-local: html-local
+ @$(MKDIR_P) $(htmldir)/html
+ @cp -r ${top_builddir}/html $(htmldir)/
+
+html-local: docs/conf.py
+ @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -nW -b html $(ALLSPHINXOPTS) ${top_builddir}/html
+
+singlehtml: html-local
+ @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
+
+pickle: docs/conf.py
+ PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json: docs/conf.py
+ PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp: docs/conf.py
+ PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
+
+epub: docs/conf.py
+ PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
+
+latex: docs/conf.py
+ PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf: latex
+ PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(SPHINX_BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
+
+text: docs/conf.py
+ @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
+
+changes: docs/conf.py
+ @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
+
+linkcheck: docs/conf.py
+ PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
+
+doctest: docs/conf.py
+ PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(SPHINX_BUILDDIR)/doctest/output.txt."