1 # Makefile for Sphinx documentation
4 # You can set these variables from the command line.
6 SPHINXBUILD = PYTHONPATH=../:$(PYTHONPATH) sphinx-build
10 PAPEROPT_a4 = -D latex_paper_size=a4
11 PAPEROPT_letter = -D latex_paper_size=letter
12 ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14 .PHONY: help clean text html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
17 @echo "Please use \`make <target>' where <target> is one of"
18 @echo " text to make text files"
19 @echo " html to make standalone HTML files"
20 @echo " dirhtml to make HTML files named index.html in directories"
21 @echo " pickle to make pickle files"
22 @echo " json to make JSON files"
23 @echo " htmlhelp to make HTML files and a HTML help project"
24 @echo " qthelp to make HTML files and a qthelp project"
25 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
26 @echo " changes to make an overview of all changed/added/deprecated items"
27 @echo " linkcheck to check all external links for integrity"
28 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
29 @echo " coverage to generate a docstring coverage report"
35 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text
37 @echo "Build finished. The text files are in _build/text."
40 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
42 @echo "Build finished. The HTML pages are in _build/html."
45 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
47 @echo "Build finished. The HTML pages are in _build/dirhtml."
50 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
52 @echo "Build finished; now you can process the pickle files."
55 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
57 @echo "Build finished; now you can process the JSON files."
60 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
62 @echo "Build finished; now you can run HTML Help Workshop with the" \
63 ".hhp project file in _build/htmlhelp."
66 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
68 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
69 ".qhcp project file in _build/qthelp, like this:"
70 @echo "# qcollectiongenerator _build/qthelp/Eventlet.qhcp"
71 @echo "To view the help file:"
72 @echo "# assistant -collectionFile _build/qthelp/Eventlet.qhc"
75 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
77 @echo "Build finished; the LaTeX files are in _build/latex."
78 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
79 "run these through (pdf)latex."
82 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
84 @echo "The overview file is in _build/changes."
87 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
89 @echo "Link check complete; look for any errors in the above output " \
90 "or in _build/linkcheck/output.txt."
93 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
94 @echo "Testing of doctests in the sources finished, look at the " \
95 "results in _build/doctest/output.txt."
98 $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) _build/coverage
99 @echo "Coverage report finished, look at the " \
100 "results in _build/coverage/python.txt."