1
# Makefile for Sphinx documentation
4
# You can set these variables from the command line.
6
SPHINXBUILD = sphinx-build
10
SPHINXAPIDOC = sphinx-apidoc
13
PAPEROPT_a4 = -D latex_paper_size=a4
14
PAPEROPT_letter = -D latex_paper_size=letter
15
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16
# the i18n builder cannot share the environment and doctrees with the others
17
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
22
@echo "Please use \`make <target>' where <target> is one of"
23
@echo " autodoc generate the autodoc templates"
24
@echo " html to make standalone HTML files"
25
@echo " dirhtml to make HTML files named index.html in directories"
26
@echo " singlehtml to make a single large HTML file"
27
@echo " pickle to make pickle files"
28
@echo " json to make JSON files"
29
@echo " htmlhelp to make HTML files and a HTML help project"
30
@echo " qthelp to make HTML files and a qthelp project"
31
@echo " devhelp to make HTML files and a Devhelp project"
32
@echo " epub to make an epub"
33
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
34
@echo " latexpdf to make LaTeX files and run them through pdflatex"
35
@echo " text to make text files"
36
@echo " man to make manual pages"
37
@echo " texinfo to make Texinfo files"
38
@echo " info to make Texinfo files and run them through makeinfo"
39
@echo " gettext to make PO message catalogs"
40
@echo " changes to make an overview of all changed/added/deprecated items"
41
@echo " linkcheck to check all external links for integrity"
42
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
48
$(SPHINXAPIDOC) -f -o $(SOURCEDIR) ../keystone
51
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
53
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
58
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
63
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
68
@echo "Build finished; now you can process the pickle files."
71
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
73
@echo "Build finished; now you can process the JSON files."
76
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
78
@echo "Build finished; now you can run HTML Help Workshop with the" \
79
".hhp project file in $(BUILDDIR)/htmlhelp."
82
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
84
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
85
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
86
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/keystone.qhcp"
87
@echo "To view the help file:"
88
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/keystone.qhc"
91
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
93
@echo "Build finished."
94
@echo "To view the help file:"
95
@echo "# mkdir -p $$HOME/.local/share/devhelp/keystone"
96
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/keystone"
100
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
102
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
108
@echo "Run \`make' in that directory to run these through (pdf)latex" \
109
"(use \`make latexpdf' here to do that automatically)."
112
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
113
@echo "Running LaTeX files through pdflatex..."
114
$(MAKE) -C $(BUILDDIR)/latex all-pdf
115
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
120
@echo "Build finished. The text files are in $(BUILDDIR)/text."
123
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
125
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
128
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
131
@echo "Run \`make' in that directory to run these through makeinfo" \
132
"(use \`make info' here to do that automatically)."
135
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
136
@echo "Running Texinfo files through makeinfo..."
137
make -C $(BUILDDIR)/texinfo info
138
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
141
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
143
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
146
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
148
@echo "The overview file is in $(BUILDDIR)/changes."
151
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
153
@echo "Link check complete; look for any errors in the above output " \
154
"or in $(BUILDDIR)/linkcheck/output.txt."
157
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
158
@echo "Testing of doctests in the sources finished, look at the " \
159
"results in $(BUILDDIR)/doctest/output.txt."
added
removed
docs/Makefile
