Debian Codegraph @

doc/Makefile

raw
1 # Makefile for Sphinx documentation
2 #
3
4 # You can set these variables from the command line.
5 SPHINXOPTS = -v
6 SPHINXBUILD = sphinx-build
7 PAPER =
8 BUILDDIR = _build
9
10 # User-friendly check for sphinx-build
11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13 endif
14
15 # Internal variables.
16 PAPEROPT_a4 = -D latex_paper_size=a4
17 PAPEROPT_letter = -D latex_paper_size=letter
18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19 # the i18n builder cannot share the environment and doctrees with the others
20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21
22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23
24 help:
25 @echo "Please use \`make <target>' where <target> is one of"
26 @echo " html to make standalone HTML files"
27 @echo " dirhtml to make HTML files named index.html in directories"
28 @echo " singlehtml to make a single large HTML file"
29 @echo " pickle to make pickle files"
30 @echo " json to make JSON files"
31 @echo " htmlhelp to make HTML files and a HTML help project"
32 @echo " qthelp to make HTML files and a qthelp project"
33 @echo " devhelp to make HTML files and a Devhelp project"
34 @echo " epub to make an epub"
35 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36 @echo " latexpdf to make LaTeX files and run them through pdflatex"
37 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38 @echo " text to make text files"
39 @echo " man to make manual pages"
40 @echo " texinfo to make Texinfo files"
41 @echo " info to make Texinfo files and run them through makeinfo"
42 @echo " gettext to make PO message catalogs"
43 @echo " changes to make an overview of all changed/added/deprecated items"
44 @echo " xml to make Docutils-native XML files"
45 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
46 @echo " linkcheck to check all external links for integrity"
47 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
48
49 clean:
50 -rm -rf $(BUILDDIR)/*
51 -rm -rf auto_examples/
52 -rm -rf generated/*
53 -rm -rf modules/generated/*
54
55 html:
56 # These two lines make the build a bit more lengthy, and the
57 # the embedding of images more robust
58 rm -rf $(BUILDDIR)/html/_images
59 #rm -rf _build/doctrees/
60 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
61 touch $(BUILDDIR)/html/.nojekyll
62 @echo
63 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
64
65 dirhtml:
66 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
67 @echo
68 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
69
70 singlehtml:
71 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
72 @echo
73 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
74
75 pickle:
76 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
77 @echo
78 @echo "Build finished; now you can process the pickle files."
79
80 json:
81 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
82 @echo
83 @echo "Build finished; now you can process the JSON files."
84
85 htmlhelp:
86 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
87 @echo
88 @echo "Build finished; now you can run HTML Help Workshop with the" \
89 ".hhp project file in $(BUILDDIR)/htmlhelp."
90
91 qthelp:
92 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
93 @echo
94 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
95 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
96 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/imbalanced-learn.qhcp"
97 @echo "To view the help file:"
98 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/imbalanced-learn.qhc"
99
100 devhelp:
101 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
102 @echo
103 @echo "Build finished."
104 @echo "To view the help file:"
105 @echo "# mkdir -p $$HOME/.local/share/devhelp/imbalanced-learn"
106 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/imbalanced-learn"
107 @echo "# devhelp"
108
109 epub:
110 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
111 @echo
112 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
113
114 latex:
115 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
116 @echo
117 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
118 @echo "Run \`make' in that directory to run these through (pdf)latex" \
119 "(use \`make latexpdf' here to do that automatically)."
120
121 latexpdf:
122 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
123 @echo "Running LaTeX files through pdflatex..."
124 $(MAKE) -C $(BUILDDIR)/latex all-pdf
125 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
126
127 latexpdfja:
128 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
129 @echo "Running LaTeX files through platex and dvipdfmx..."
130 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
131 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
132
133 text:
134 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
135 @echo
136 @echo "Build finished. The text files are in $(BUILDDIR)/text."
137
138 man:
139 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
140 @echo
141 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
142
143 texinfo:
144 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
145 @echo
146 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
147 @echo "Run \`make' in that directory to run these through makeinfo" \
148 "(use \`make info' here to do that automatically)."
149
150 info:
151 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
152 @echo "Running Texinfo files through makeinfo..."
153 make -C $(BUILDDIR)/texinfo info
154 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
155
156 gettext:
157 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
158 @echo
159 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
160
161 changes:
162 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
163 @echo
164 @echo "The overview file is in $(BUILDDIR)/changes."
165
166 linkcheck:
167 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
168 @echo
169 @echo "Link check complete; look for any errors in the above output " \
170 "or in $(BUILDDIR)/linkcheck/output.txt."
171
172 doctest:
173 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
174 @echo "Testing of doctests in the sources finished, look at the " \
175 "results in $(BUILDDIR)/doctest/output.txt."
176
177 xml:
178 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
179 @echo
180 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
181
182 pseudoxml:
183 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
184 @echo
185 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."