1 # Makefile for Sphinx documentation
4 # You can set these variables from the command line.
6 SPHINXBUILD
= sphinx-build
11 PAPEROPT_a4
= -D latex_paper_size
=a4
12 PAPEROPT_letter
= -D latex_paper_size
=letter
13 ALLSPHINXOPTS
= -d
$(BUILDDIR
)/doctrees
$(PAPEROPT_
$(PAPER
)) $(SPHINXOPTS
) .
14 # the i18n builder cannot share the environment and doctrees with the others
15 I18NSPHINXOPTS
= $(PAPEROPT_
$(PAPER
)) $(SPHINXOPTS
) .
17 .PHONY
: help
clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
20 @echo
"Please use \`make <target>' where <target> is one of"
21 @echo
" html to make standalone HTML files"
22 @echo
" dirhtml to make HTML files named index.html in directories"
23 @echo
" singlehtml to make a single large HTML file"
24 @echo
" pickle to make pickle files"
25 @echo
" json to make JSON files"
26 @echo
" htmlhelp to make HTML files and a HTML help project"
27 @echo
" qthelp to make HTML files and a qthelp project"
28 @echo
" devhelp to make HTML files and a Devhelp project"
29 @echo
" epub to make an epub"
30 @echo
" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31 @echo
" latexpdf to make LaTeX files and run them through pdflatex"
32 @echo
" text to make text files"
33 @echo
" man to make manual pages"
34 @echo
" texinfo to make Texinfo files"
35 @echo
" info to make Texinfo files and run them through makeinfo"
36 @echo
" gettext to make PO message catalogs"
37 @echo
" changes to make an overview of all changed/added/deprecated items"
38 @echo
" linkcheck to check all external links for integrity"
39 @echo
" doctest to run all doctests embedded in the documentation (if enabled)"
45 $(SPHINXBUILD
) -b html
$(ALLSPHINXOPTS
) $(BUILDDIR
)/html
47 @echo
"Build finished. The HTML pages are in $(BUILDDIR)/html."
50 $(SPHINXBUILD
) -b dirhtml
$(ALLSPHINXOPTS
) $(BUILDDIR
)/dirhtml
52 @echo
"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
55 $(SPHINXBUILD
) -b singlehtml
$(ALLSPHINXOPTS
) $(BUILDDIR
)/singlehtml
57 @echo
"Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
60 $(SPHINXBUILD
) -b pickle
$(ALLSPHINXOPTS
) $(BUILDDIR
)/pickle
62 @echo
"Build finished; now you can process the pickle files."
65 $(SPHINXBUILD
) -b json
$(ALLSPHINXOPTS
) $(BUILDDIR
)/json
67 @echo
"Build finished; now you can process the JSON files."
70 $(SPHINXBUILD
) -b htmlhelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/htmlhelp
72 @echo
"Build finished; now you can run HTML Help Workshop with the" \
73 ".hhp project file in $(BUILDDIR)/htmlhelp."
76 $(SPHINXBUILD
) -b qthelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/qthelp
78 @echo
"Build finished; now you can run "qcollectiongenerator
" with the" \
79 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80 @echo
"# qcollectiongenerator $(BUILDDIR)/qthelp/pep8.qhcp"
81 @echo
"To view the help file:"
82 @echo
"# assistant -collectionFile $(BUILDDIR)/qthelp/pep8.qhc"
85 $(SPHINXBUILD
) -b devhelp
$(ALLSPHINXOPTS
) $(BUILDDIR
)/devhelp
87 @echo
"Build finished."
88 @echo
"To view the help file:"
89 @echo
"# mkdir -p $$HOME/.local/share/devhelp/pep8"
90 @echo
"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pep8"
94 $(SPHINXBUILD
) -b epub
$(ALLSPHINXOPTS
) $(BUILDDIR
)/epub
96 @echo
"Build finished. The epub file is in $(BUILDDIR)/epub."
99 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
101 @echo
"Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102 @echo
"Run \`make' in that directory to run these through (pdf)latex" \
103 "(use \`make latexpdf' here to do that automatically)."
106 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
107 @echo
"Running LaTeX files through pdflatex..."
108 $(MAKE
) -C
$(BUILDDIR
)/latex all-pdf
109 @echo
"pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
112 $(SPHINXBUILD
) -b text
$(ALLSPHINXOPTS
) $(BUILDDIR
)/text
114 @echo
"Build finished. The text files are in $(BUILDDIR)/text."
117 $(SPHINXBUILD
) -b man
$(ALLSPHINXOPTS
) $(BUILDDIR
)/man
119 @echo
"Build finished. The manual pages are in $(BUILDDIR)/man."
122 $(SPHINXBUILD
) -b texinfo
$(ALLSPHINXOPTS
) $(BUILDDIR
)/texinfo
124 @echo
"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125 @echo
"Run \`make' in that directory to run these through makeinfo" \
126 "(use \`make info' here to do that automatically)."
129 $(SPHINXBUILD
) -b texinfo
$(ALLSPHINXOPTS
) $(BUILDDIR
)/texinfo
130 @echo
"Running Texinfo files through makeinfo..."
131 make
-C
$(BUILDDIR
)/texinfo
info
132 @echo
"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
135 $(SPHINXBUILD
) -b gettext
$(I18NSPHINXOPTS
) $(BUILDDIR
)/locale
137 @echo
"Build finished. The message catalogs are in $(BUILDDIR)/locale."
140 $(SPHINXBUILD
) -b changes
$(ALLSPHINXOPTS
) $(BUILDDIR
)/changes
142 @echo
"The overview file is in $(BUILDDIR)/changes."
145 $(SPHINXBUILD
) -b linkcheck
$(ALLSPHINXOPTS
) $(BUILDDIR
)/linkcheck
147 @echo
"Link check complete; look for any errors in the above output " \
148 "or in $(BUILDDIR)/linkcheck/output.txt."
151 $(SPHINXBUILD
) -b doctest
$(ALLSPHINXOPTS
) $(BUILDDIR
)/doctest
152 @echo
"Testing of doctests in the sources finished, look at the " \
153 "results in $(BUILDDIR)/doctest/output.txt."