@@ -20,27 +20,18 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
2020
2121help :
2222 @echo " Please use \` make <target>' where <target> is one of"
23- @echo " html to make standalone HTML files"
24- @echo " dirhtml to make HTML files named index.html in directories"
25- @echo " singlehtml to make a single large HTML file"
26- @echo " pickle to make pickle files"
27- @echo " json to make JSON files"
28- @echo " htmlhelp to make HTML files and a HTML help project"
29- @echo " qthelp to make HTML files and a qthelp project"
30- @echo " devhelp to make HTML files and a Devhelp project"
31- @echo " epub to make an epub"
32- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
33- @echo " latexpdf to make LaTeX files and run them through pdflatex"
34- @echo " text to make text files"
35- @echo " man to make manual pages"
36- @echo " changes to make an overview of all changed/added/deprecated items"
37- @echo " linkcheck to check all external links for integrity"
38- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
39- @echo " show to open the built documentation in the default browser"
40-
41- clean :
42- -rm -rf $(BUILDDIR )
43- -rm -rf $(SRCDIR ) /generated
23+ @echo " help to view this help"
24+ @echo " html to make standalone HTML files"
25+ @echo " html-noplot to make standalone HTML files, skip gallery"
26+ @echo " html-noapi to make standalone HTML files, skip the API"
27+ @echo " html-quick to make standalone HTML files, skip the gallery and API"
28+ @echo " clean to remove all built files"
29+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
30+ @echo " linkcheck to check all external links for integrity"
31+ @echo " show to open the built documentation in the default browser"
32+ @echo " livehtml to auto build the docs when any file changes are detected."
33+ @echo " You need to install sphinx-autobuild first:"
34+ @echo " conda install -c conda-forge sphinx-autobuild"
4435
4536html :
4637 $(SPHINXBUILD ) $(WARNING_TO_ERROR ) -b html $(ALLSPHINXOPTS ) $(BUILDDIR ) /html
@@ -62,94 +53,23 @@ html-quick:
6253 @echo
6354 @echo " Build finished. The HTML (no gallery or api docs) pages are in $( BUILDDIR) "
6455
65- dirhtml :
66- $(SPHINXBUILD ) -b dirhtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /dirhtml
67- @echo
68- @echo " Build finished. The HTML pages are in $( BUILDDIR) "
69-
70- singlehtml :
71- $(SPHINXBUILD ) -b singlehtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /singlehtml
72- @echo
73- @echo " Build finished. The HTML page is in $( BUILDDIR) "
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) "
90-
91- qthelp :
92- $(SPHINXBUILD ) -b qthelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /qthelp
93- @echo
94- @echo " Build finished; now you can run " " with the" \
95- " .qhcp project file in $( BUILDDIR) "
96- @echo " # qcollectiongenerator $( BUILDDIR) "
97- @echo " To view the help file:"
98- @echo " # assistant -collectionFile $( BUILDDIR) "
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/Iris"
106- @echo " # ln -s $( BUILDDIR) $$ HOME/.local/share/devhelp/Iris"
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) "
113-
114- latex :
115- $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
116- @echo
117- @echo " Build finished; the LaTeX files are in $( BUILDDIR) "
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 : latex
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) "
126-
127- text :
128- $(SPHINXBUILD ) -b text $(ALLSPHINXOPTS ) $(BUILDDIR ) /text
129- @echo
130- @echo " Build finished. The text files are in $( BUILDDIR) "
131-
132- man :
133- $(SPHINXBUILD ) -b man $(ALLSPHINXOPTS ) $(BUILDDIR ) /man
134- @echo
135- @echo " Build finished. The manual pages are in $( BUILDDIR) "
56+ clean :
57+ -rm -rf $(BUILDDIR )
58+ -rm -rf $(SRCDIR ) /generated
13659
137- changes :
138- $(SPHINXBUILD ) -b changes $(ALLSPHINXOPTS ) $(BUILDDIR ) /changes
139- @echo
140- @echo " The overview file is in $( BUILDDIR) changes ."
60+ doctest :
61+ $(SPHINXBUILD ) -b doctest $(ALLSPHINXOPTS ) $(BUILDDIR ) /doctest
62+ @echo " Testing of doctests in the sources finished, look at the "
63+ @echo " results in $( BUILDDIR) doctest/output.txt ."
14164
14265linkcheck :
14366 $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck
14467 @echo
145- @echo " Link check complete; look for any errors in the above output " \
146- " or in $( BUILDDIR) "
147-
148- doctest :
149- $(SPHINXBUILD ) -b doctest $(ALLSPHINXOPTS ) $(BUILDDIR ) /doctest
150- @echo " Testing of doctests in the sources finished, look at the " \
151- " results in $( BUILDDIR) "
68+ @echo " Link check complete; look for any errors in the above output "
69+ @echo " or in $( BUILDDIR) "
15270
15371show :
15472 @python -c " import webbrowser; webbrowser.open_new_tab('file://$( shell pwd) $( BUILDDIR) "
15573
74+ livehtml :
75+ sphinx-autobuild " $( SOURCEDIR) " " $( BUILDDIR) " $(SPHINXOPTS ) --ignore generated $(O )
0 commit comments