Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 167 lines (140 sloc) 5.934 kB
0801922 @tonysyu DOC: Add basic sphinx documentation.
authored
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 " text to make text files"
33 @echo " man to make manual pages"
34 @echo " texinfo to make Texinfo files"
35 @echo " info to make Texinfo files and run them through makeinfo"
36 @echo " gettext to make PO message catalogs"
37 @echo " changes to make an overview of all changed/added/deprecated items"
38 @echo " linkcheck to check all external links for integrity"
39 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
40
41 clean:
42 -rm -rf $(BUILDDIR)/*
c0f22c1 @tonysyu DOC: Fill in documentation structure.
authored
43 -rm -rf source/api
038ee21 @tonysyu Add handling for multiple galleries.
authored
44 -find ./source/auto_examples/* -type f | xargs rm -f
45 -find ./source/auto_tutorials/* -type f | xargs rm -f
0801922 @tonysyu DOC: Add basic sphinx documentation.
authored
46
c0f22c1 @tonysyu DOC: Fill in documentation structure.
authored
47 api:
48 @mkdir -p source/api
49 python tools/build_modref_templates.py
50 @echo "Build API docs...done."
51
52 html: api
0801922 @tonysyu DOC: Add basic sphinx documentation.
authored
53 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
799db4b @tonysyu DOC: Add gh-pages flag for correct build.
authored
54 # turn off jekyll processing on github.
55 touch $(BUILDDIR)/html/.nojekyll
0801922 @tonysyu DOC: Add basic sphinx documentation.
authored
56 @echo
57 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58
66ea002 @tonysyu DOC: Add `push` command to Makefile
authored
59 push: html
60 ghp-import -p $(BUILDDIR)/html/
61
0801922 @tonysyu DOC: Add basic sphinx documentation.
authored
62 dirhtml:
63 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64 @echo
65 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
66
67 singlehtml:
68 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
69 @echo
70 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
71
72 pickle:
73 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
74 @echo
75 @echo "Build finished; now you can process the pickle files."
76
77 json:
78 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
79 @echo
80 @echo "Build finished; now you can process the JSON files."
81
82 htmlhelp:
83 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
84 @echo
85 @echo "Build finished; now you can run HTML Help Workshop with the" \
86 ".hhp project file in $(BUILDDIR)/htmlhelp."
87
88 qthelp:
89 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
90 @echo
91 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
92 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
93 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/mpltools.qhcp"
94 @echo "To view the help file:"
95 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/mpltools.qhc"
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/mpltools"
103 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/mpltools"
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 text:
125 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
126 @echo
127 @echo "Build finished. The text files are in $(BUILDDIR)/text."
128
129 man:
130 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
131 @echo
132 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
133
134 texinfo:
135 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
136 @echo
137 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
138 @echo "Run \`make' in that directory to run these through makeinfo" \
139 "(use \`make info' here to do that automatically)."
140
141 info:
142 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
143 @echo "Running Texinfo files through makeinfo..."
144 make -C $(BUILDDIR)/texinfo info
145 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
146
147 gettext:
148 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
149 @echo
150 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
151
152 changes:
153 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
154 @echo
155 @echo "The overview file is in $(BUILDDIR)/changes."
156
157 linkcheck:
158 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
159 @echo
160 @echo "Link check complete; look for any errors in the above output " \
161 "or in $(BUILDDIR)/linkcheck/output.txt."
162
163 doctest:
164 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
165 @echo "Testing of doctests in the sources finished, look at the " \
166 "results in $(BUILDDIR)/doctest/output.txt."
Something went wrong with that request. Please try again.