Skip to content

Commit c58b442

Browse files
committed
NF: add requirements for building docs
Use with: pip install -r doc-requirements.txt
1 parent f9614fe commit c58b442

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ script:
118118
COVER_ARGS="--with-coverage --cover-package nibabel";
119119
fi
120120
if [ "$DOC_DOC_TEST" == "1" ]; then
121-
pip install sphinx numpydoc texext;
122121
cd ../doc;
122+
pip install -r ../doc-requirements.txt
123123
make html;
124124
make doctest;
125125
else

doc-requirements.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Requirements for building docs
2+
-r requirements.txt
3+
sphinx
4+
numpydoc
5+
texext
6+
matplotlib>=1.3

doc/README.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#####################
2+
Nibabel documentation
3+
#####################
4+
5+
To build the documentation, change to the root directory (containing
6+
``setup.py``) and run::
7+
8+
pip install -r doc-requirements.txt
9+
make html

0 commit comments

Comments
 (0)