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 # the i18n builder cannot share the environment and doctrees with the others
15 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16
17 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18
19 help:
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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
33 @echo " text to make text files"
34 @echo " man to make manual pages"
35 @echo " texinfo to make Texinfo files"
36 @echo " info to make Texinfo files and run them through makeinfo"
37 @echo " gettext to make PO message catalogs"
38 @echo " changes to make an overview of all changed/added/deprecated items"
39 @echo " xml to make Docutils-native XML files"
40 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
41 @echo " linkcheck to check all external links for integrity"
42 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
43
44 clean:
45 rm -rf $(BUILDDIR)/*
46
47 html:
48 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
49 @echo
50 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
51
52 dirhtml:
53 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
54 @echo
55 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
56
57 singlehtml:
58 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
59 @echo
60 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
61
62 pickle:
63 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
64 @echo
65 @echo "Build finished; now you can process the pickle files."
66
67 json:
68 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
69 @echo
70 @echo "Build finished; now you can process the JSON files."
71
72 htmlhelp:
73 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
74 @echo
75 @echo "Build finished; now you can run HTML Help Workshop with the" \
76 ".hhp project file in $(BUILDDIR)/htmlhelp."
77
78 qthelp:
79 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
80 @echo
81 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
82 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
83 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Custodia.qhcp"
84 @echo "To view the help file:"
85 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Custodia.qhc"
86
87 devhelp:
88 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
89 @echo
90 @echo "Build finished."
91 @echo "To view the help file:"
92 @echo "# mkdir -p $$HOME/.local/share/devhelp/Custodia"
93 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Custodia"
94 @echo "# devhelp"
95
96 epub:
97 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
98 @echo
99 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
100
101 latex:
102 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
103 @echo
104 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
105 @echo "Run \`make' in that directory to run these through (pdf)latex" \
106 "(use \`make latexpdf' here to do that automatically)."
107
108 latexpdf:
109 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
110 @echo "Running LaTeX files through pdflatex..."
111 $(MAKE) -C $(BUILDDIR)/latex all-pdf
112 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
113
114 latexpdfja:
115 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
116 @echo "Running LaTeX files through platex and dvipdfmx..."
117 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
118 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
119
120 text:
121 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
122 @echo
123 @echo "Build finished. The text files are in $(BUILDDIR)/text."
124
125 man:
126 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
127 @echo
128 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
129
130 texinfo:
131 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
132 @echo
133 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
134 @echo "Run \`make' in that directory to run these through makeinfo" \
135 "(use \`make info' here to do that automatically)."
136
137 info:
138 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
139 @echo "Running Texinfo files through makeinfo..."
140 make -C $(BUILDDIR)/texinfo info
141 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
142
143 gettext:
144 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
145 @echo
146 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
147
148 changes:
149 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
150 @echo
151 @echo "The overview file is in $(BUILDDIR)/changes."
152
153 linkcheck:
154 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
155 @echo
156 @echo "Link check complete; look for any errors in the above output " \
157 "or in $(BUILDDIR)/linkcheck/output.txt."
158
159 doctest:
160 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
161 @echo "Testing of doctests in the sources finished, look at the " \
162 "results in $(BUILDDIR)/doctest/output.txt."
163
164 xml:
165 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
166 @echo
167 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
168
169 pseudoxml:
170 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
171 @echo
172 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."