| 1 |
# vim:ft=automake |
| 2 |
# included from Top Level Makefile.am |
| 3 |
# All paths should be given relative to the root |
| 4 |
|
| 5 |
# Makefile for Sphinx documentation |
| 6 |
# |
| 7 |
|
| 8 |
SPHINXOPTS = ${SPHINX_WARNINGS} -q |
| 9 |
PAPER = |
| 10 |
SPHINX_BUILDDIR = ${abs_srcdir}/docs |
| 11 |
|
| 12 |
# Internal variables. |
| 13 |
PAPEROPT_a4 = -D latex_paper_size=a4 |
| 14 |
PAPEROPT_letter = -D latex_paper_size=letter |
| 15 |
ALLSPHINXOPTS = -c $(top_builddir)/docs $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINX_BUILDDIR) |
| 16 |
|
| 17 |
.PHONY: clean-docs-check |
| 18 |
clean-docs-check: |
| 19 |
-rm -rf docs/_build docs/doctrees man/.doctrees |
| 20 |
|
| 21 |
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest |
| 22 |
|
| 23 |
man: docs/conf.py |
| 24 |
@PYTHONPATH=$(SPHINX_BUILDDIR)/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man |
| 25 |
|
| 26 |
install-html-local: html-local |
| 27 |
@$(MKDIR_P) $(htmldir)/html |
| 28 |
@cp -r ${top_builddir}/html $(htmldir)/ |
| 29 |
|
| 30 |
html-local: docs/conf.py |
| 31 |
@PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -nW -b html $(ALLSPHINXOPTS) ${top_builddir}/html |
| 32 |
|
| 33 |
singlehtml: html-local |
| 34 |
@PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml |
| 35 |
|
| 36 |
pickle: docs/conf.py |
| 37 |
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle |
| 38 |
@echo |
| 39 |
@echo "Build finished; now you can process the pickle files." |
| 40 |
|
| 41 |
json: docs/conf.py |
| 42 |
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json |
| 43 |
@echo |
| 44 |
@echo "Build finished; now you can process the JSON files." |
| 45 |
|
| 46 |
htmlhelp: docs/conf.py |
| 47 |
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp |
| 48 |
@echo |
| 49 |
@echo "Build finished; now you can run HTML Help Workshop with the" \ |
| 50 |
".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp." |
| 51 |
|
| 52 |
epub: docs/conf.py |
| 53 |
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub |
| 54 |
@echo |
| 55 |
@echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub." |
| 56 |
|
| 57 |
latex: docs/conf.py |
| 58 |
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex |
| 59 |
@echo |
| 60 |
@echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex." |
| 61 |
@echo "Run \`make' in that directory to run these through (pdf)latex" \ |
| 62 |
"(use \`make latexpdf' here to do that automatically)." |
| 63 |
|
| 64 |
latexpdf: latex |
| 65 |
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex |
| 66 |
@echo "Running LaTeX files through pdflatex..." |
| 67 |
make -C $(SPHINX_BUILDDIR)/latex all-pdf |
| 68 |
@echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex." |
| 69 |
|
| 70 |
text: docs/conf.py |
| 71 |
@PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text |
| 72 |
|
| 73 |
changes: docs/conf.py |
| 74 |
@PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes |
| 75 |
|
| 76 |
linkcheck: docs/conf.py |
| 77 |
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck |
| 78 |
|
| 79 |
doctest: docs/conf.py |
| 80 |
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest |
| 81 |
@echo "Testing of doctests in the sources finished, look at the " \ |
| 82 |
"results in $(SPHINX_BUILDDIR)/doctest/output.txt." |