Debian Codegraph @

docs/Makefile

raw
1 # Makefile for Sphinx documentation
2 #
3
4 # You can set these variables from the command line.
5 SPHINXOPTS =
6 SPHINXBUILD = sphinx-build
7 PAPER =
8 BUILDDIR = build
9
10 # Internal variables.
11 PAPEROPT_a4 = -D latex_paper_size=a4
12 PAPEROPT_letter = -D latex_paper_size=letter
13 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14
15 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
16
17 help:
18 @echo "Please use \`make <target>' where <target> is one of"
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 " texinfo to make Texinfo files"
27 @echo " info to make Texinfo files and run them through makeinfo"
28 @echo " changes to make an overview of all changed/added/deprecated items"
29 @echo " docset to make a docset for use with the Dash/Zeal api browsers"
30 @echo " linkcheck to check all external links for integrity"
31 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
32
33 clean:
34 -rm -rf $(BUILDDIR)/*
35
36 html:
37 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
38 @echo
39 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
40
41 dirhtml:
42 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
43 @echo
44 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
45
46 pickle:
47 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
48 @echo
49 @echo "Build finished; now you can process the pickle files."
50
51 json:
52 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
53 @echo
54 @echo "Build finished; now you can process the JSON files."
55
56 htmlhelp:
57 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
58 @echo
59 @echo "Build finished; now you can run HTML Help Workshop with the" \
60 ".hhp project file in $(BUILDDIR)/htmlhelp."
61
62 qthelp:
63 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
64 @echo
65 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
66 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
67 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/traits.qhcp"
68 @echo "To view the help file:"
69 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/traits.qhc"
70
71 latex:
72 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
73 @echo
74 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
75 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
76 "run these through (pdf)latex."
77
78 changes:
79 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
80 @echo
81 @echo "The overview file is in $(BUILDDIR)/changes."
82
83 linkcheck:
84 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
85 @echo
86 @echo "Link check complete; look for any errors in the above output " \
87 "or in $(BUILDDIR)/linkcheck/output.txt."
88
89 doctest:
90 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
91 @echo "Testing of doctests in the sources finished, look at the " \
92 "results in $(BUILDDIR)/doctest/output.txt."
93
94 texinfo:
95 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
96 @echo
97 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
98 @echo "Run \`make' in that directory to run these through makeinfo" \
99 "(use \`make info' here to do that automatically)."
100
101 info:
102 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
103 @echo "Running Texinfo files through makeinfo..."
104 make -C $(BUILDDIR)/texinfo info
105 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
106
107 docset:
108 BUILD_DOCSET=1 $(SPHINXBUILD) -b html -c source/ $(ALLSPHINXOPTS) $(BUILDDIR)/docset_html
109 @echo "Creating docset with doc2dash"
110 doc2dash -f -d $(BUILDDIR) -i $(BUILDDIR)/docset_html/_static/img/e-logo.png -n Traits $(BUILDDIR)/docset_html
111 @echo "Traits docset is available in $(BUILDDIR)/Traits.docset"