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
|
# Makefile for Sphinx documentation
#
# The Python executable to be used
#
PYTHON ?= python
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
# Internal variables.
BUILDROOT = ../build
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDROOT)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# API generation
API_DIR = source/reference
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " api to make the auto-generated API files"
@echo " pickle to make pickle files (usable by e.g. sphinx-web)"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " changes to make an overview over 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)"
@echo " gitwash-update update git workflow from source repo"
clean: api-clean
-rm -rf $(BUILDROOT)/*
-rm *-stamp
api-clean:
rm -rf $(API_DIR)/*.rst
api: api-stamp
api-stamp:
@mkdir -p $(API_DIR)
$(PYTHON) tools/build_modref_templates.py nibabel $(API_DIR) False
@echo "Build API docs...done."
@touch $@
html-only:
mkdir -p $(BUILDROOT)/html $(BUILDROOT)/doctrees
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDROOT)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDROOT)/html."
html: api-stamp html-only
pickle:
mkdir -p $(BUILDROOT)/pickle $(BUILDROOT)/doctrees
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDROOT)/pickle
@echo
@echo "Build finished; now you can process the pickle files or run"
@echo " sphinx-web $(BUILDROOT)/pickle"
@echo "to start the sphinx-web server."
web: pickle
htmlhelp:
mkdir -p $(BUILDROOT)/htmlhelp $(BUILDROOT)/doctrees
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDROOT)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDROOT)/htmlhelp."
latex:
mkdir -p $(BUILDROOT)/latex $(BUILDROOT)/doctrees
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDROOT)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDROOT)/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
changes:
mkdir -p $(BUILDROOT)/changes $(BUILDROOT)/doctrees
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDROOT)/changes
@echo
@echo "The overview file is in $(BUILDROOT)/changes."
linkcheck:
mkdir -p $(BUILDROOT)/linkcheck $(BUILDROOT)/doctrees
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDROOT)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDROOT)/linkcheck/output.txt."
doctest: api-clean
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDROOT)/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 source nibabel --github-user=nipy \
--project-url=http://nipy.org/nibabel \
--project-ml-url=https://mail.python.org/mailman/listinfo/neuroimaging
|
