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
|
# Makefile for Sphinx documentation
#
# 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 api htmlonly latex changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html make the HTML documentation"
@echo " api make API documents only"
@echo " latex make the LaTeX, you can set PAPER=a4 or PAPER=letter"
@echo " pdf make <latex> and run the PDF generation"
@echo " changes make an overview of all changed/added/deprecated" \
"items (ChangeLog)"
@echo " linkcheck check all external links for integrity"
@echo " doctest run all doctests embedded in the documentation"
@echo " sf_satra copy html files to sourceforge (satra only)"
clean:
-rm -rf _build/* *~ api/generated interfaces/generated users/examples documentation.zip
htmlonly:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
@echo
@echo "Build finished. The HTML pages are in _build/html."
api:
rm -rf api/generated
python ../tools/build_modref_templates.py
rm -rf interfaces/generated
python ../tools/build_interface_docs.py
@echo "Build API docs finished."
html: clean examples2rst api htmlonly
@echo "Build HTML and API finished."
examples2rst:
mkdir -p users/examples
../tools/make_examples.py --no-exec
@echo "examples2rst finished."
latex: api
$(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."
pdf: latex
cd _build/latex && make all-pdf
all: html pdf
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."
gitwash-update:
python ../tools/gitwash_dumper.py devel nipype \
--repo-name=nipype \
--github-user=nipy \
--project-url=http://nipy.org/nipype \
--project-ml-url=http://mail.scipy.org/mailman/listinfo/nipy-devel
@echo "gitwash updated"
# Sourceforge doesn't appear to have a way of copying the files
# without specifying a username. So we'll probably have one target
# for each project admin
sf_satra_nightly: html
@echo "Copying html files to sourceforge..."
scp -r _build/html/* satra,nipy@web.sourceforge.net:htdocs/nipype-nightly/
sf_satra: html
@echo "Copying html files to sourceforge..."
rsync -auv _build/html/. satra,nipy@web.sourceforge.net:htdocs/nipype/.
sf_filo: html
@echo "Copying html files to sourceforge..."
rsync -auv _build/html/. gorgolewski,nipy@web.sourceforge.net:htdocs/nipype/.
|
