Debian Codegraph @

docs/Makefile

raw
1 # Makefile for Sphinx documentation
2 #
3
4 # You can set these variables from the command line.
5 SPHINXOPTS = -W
6 SPHINXBUILD = DATALAD_SPHINX_RUN=1 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 coverage 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 " applehelp to make an Apple Help Book"
29 @echo " devhelp to make HTML files and a Devhelp project"
30 @echo " epub to make an epub"
31 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
32 @echo " latexpdf to make LaTeX files and run them through pdflatex"
33 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
34 @echo " text to make text files"
35 @echo " man to make manual pages"
36 @echo " texinfo to make Texinfo files"
37 @echo " info to make Texinfo files and run them through makeinfo"
38 @echo " gettext to make PO message catalogs"
39 @echo " changes to make an overview of all changed/added/deprecated items"
40 @echo " xml to make Docutils-native XML files"
41 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
42 @echo " linkcheck to check all external links for integrity"
43 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
44 @echo " coverage to run coverage check of the documentation (if enabled)"
45
46 clean:
47 rm -rf $(BUILDDIR)/* source/generated source/_extras/schema*.json source/build
48
49 html:
50 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
51 @echo
52 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
53
54 dirhtml:
55 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
56 @echo
57 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
58
59 singlehtml:
60 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
61 @echo
62 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
63
64 pickle:
65 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
66 @echo
67 @echo "Build finished; now you can process the pickle files."
68
69 json:
70 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
71 @echo
72 @echo "Build finished; now you can process the JSON files."
73
74 htmlhelp:
75 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
76 @echo
77 @echo "Build finished; now you can run HTML Help Workshop with the" \
78 ".hhp project file in $(BUILDDIR)/htmlhelp."
79
80 qthelp:
81 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
82 @echo
83 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
84 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
85 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/datalad.qhcp"
86 @echo "To view the help file:"
87 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/datalad.qhc"
88
89 applehelp:
90 $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
91 @echo
92 @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
93 @echo "N.B. You won't be able to view it unless you put it in" \
94 "~/Library/Documentation/Help or install it in your application" \
95 "bundle."
96
97 devhelp:
98 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
99 @echo
100 @echo "Build finished."
101 @echo "To view the help file:"
102 @echo "# mkdir -p $$HOME/.local/share/devhelp/datalad"
103 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/datalad"
104 @echo "# devhelp"
105
106 epub:
107 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
108 @echo
109 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
110
111 latex:
112 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
113 @echo
114 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
115 @echo "Run \`make' in that directory to run these through (pdf)latex" \
116 "(use \`make latexpdf' here to do that automatically)."
117
118 latexpdf:
119 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
120 @echo "Running LaTeX files through pdflatex..."
121 $(MAKE) -C $(BUILDDIR)/latex all-pdf
122 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
123
124 latexpdfja:
125 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
126 @echo "Running LaTeX files through platex and dvipdfmx..."
127 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
128 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
129
130 text:
131 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
132 @echo
133 @echo "Build finished. The text files are in $(BUILDDIR)/text."
134
135 man:
136 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
137 @echo
138 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
139
140 texinfo:
141 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
142 @echo
143 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
144 @echo "Run \`make' in that directory to run these through makeinfo" \
145 "(use \`make info' here to do that automatically)."
146
147 info:
148 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
149 @echo "Running Texinfo files through makeinfo..."
150 make -C $(BUILDDIR)/texinfo info
151 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
152
153 gettext:
154 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
155 @echo
156 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
157
158 changes:
159 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
160 @echo
161 @echo "The overview file is in $(BUILDDIR)/changes."
162
163 linkcheck:
164 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
165 @echo
166 @echo "Link check complete; look for any errors in the above output " \
167 "or in $(BUILDDIR)/linkcheck/output.txt."
168
169 doctest:
170 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
171 @echo "Testing of doctests in the sources finished, look at the " \
172 "results in $(BUILDDIR)/doctest/output.txt."
173
174 coverage:
175 $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
176 @echo "Testing of coverage in the sources finished, look at the " \
177 "results in $(BUILDDIR)/coverage/python.txt."
178
179 xml:
180 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
181 @echo
182 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
183
184 pseudoxml:
185 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
186 @echo
187 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."