blob: 7b6095b1d0b0eea16b2f6380c1ded6e32ce698c3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
# 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_top_builddir}/docs
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = $(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
sphinx-help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
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@ -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
man:
@PYTHONPATH=$(SPHINX_BUILDDIR)/docs @SPHINXBUILD@ -b man $(ALLSPHINXOPTS) ${top_builddir}/man
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."
|
