Skip to content

Commit fd00d7d

Browse files
committed
DOC: make build fail when API doc build fails
Make sure we don't accidentally fail to build the API docs. Add PYTHON environment variable to override Python executable in doc Makefile, to make main Makefile. For symptoms of problem, see: #527
1 parent a7d25be commit fd00d7d

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

doc/Makefile

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Makefile for Sphinx documentation
22
#
33

4+
# The Python executable to be used
5+
#
6+
PYTHON ?= python
7+
48
# You can set these variables from the command line.
59
SPHINXOPTS =
610
SPHINXBUILD = sphinx-build
@@ -98,4 +102,3 @@ gitwash-update:
98102
python ../tools/gitwash_dumper.py source nibabel --github-user=nipy \
99103
--project-url=http://nipy.org/nibabel \
100104
--project-ml-url=https://mail.python.org/mailman/listinfo/neuroimaging
101-

doc/tools/build_modref_templates.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
def abort(error):
2121
print('*WARNING* API documentation not generated: %s' % error)
22-
exit()
22+
exit(1)
2323

2424

2525
if __name__ == '__main__':

0 commit comments

Comments
 (0)