1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
# Makefile for Sphinx documentation
#
# "https://sourceforge.net/apps/trac/sourceforge/wiki/Release files for
# download". To use, set your sourceforge username with 'export
# SF_USER=garyfallidis' or similar, then 'make upload-website'
#SF_USER ?= matthewbrett
SF_USER ?= garyfallidis
WWW_SF=nipy@web.sourceforge.net:/home/groups/n/ni/nipy/htdocs/dipy
RSYNC_SF=rsync -rzhvp --delete --chmod=Dg+s,g+rw
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean: examples-clean
-rm -rf _build/*
-rm *-stamp
examples-clean:
-cd examples_built && rm -rf *.py *.rst *.png fig
examples-clean-tgz: examples-clean examples-tgz
../tools/pack_examples.py ../dist
examples-tgz: rstexamples
../tools/pack_examples.py ../dist
gitwash-update:
python ../tools/gitwash_dumper.py devel dipy --repo-name=dipy --github-user=nipy \
--project-url=http://nipy.org/dipy \
--project-ml-url=http://mail.scipy.org/mailman/listinfo/nipy-devel
html: rstexamples html-after-examples
# build full docs including examples
html-after-examples:
# Standard html build after examples have been prepared
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
@echo
@echo "Build finished. The HTML pages are in _build/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
@echo
@echo "Build finished. The HTML pages are in _build/dirhtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in _build/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in _build/qthelp, like this:"
@echo "# qcollectiongenerator _build/qthelp/dipy.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile _build/qthelp/dipy.qhc"
latex: rstexamples latex-after-examples
latex-after-examples:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
@echo
@echo "Build finished; the LaTeX files are in _build/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
@echo
@echo "The overview file is in _build/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in _build/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in _build/doctest/output.txt."
rstexamples: rstexamples-stamp
rstexamples-stamp:
../tools/make_examples.py
touch $@
pdf: pdf-stamp
pdf-stamp: latex
cd _build/latex && make all-pdf
touch $@
# This one udates for the specific user named at the top of the makefile
upload-website: upload-website-$(SF_USER)
upload-website-%: html examples-tgz
$(RSYNC_SF) _build/html/* _build/latex/*.pdf $*,$(WWW_SF)
# This one udates for the specific user named at the top of the makefile
upload-examples: upload-examples-$(SF_USER)
upload-examples-%: examples-tgz
$(RSYNC_SF) ../dist/*-doc-examples.tar.gz $*,$(WWW_SF)
#upload-website-%: pdf-stamp html
# $(RSYNC_SF) _build/html/* _build/latex/*.pdf $*,$(WWW_SF)
|
