Skip to content

Commit 9783496

Browse files
committed
DOC: various documentation fixes
Remove custom matplotlib directives in favor of matplotlib. Rewrite and fix up a few docstrings to match numpy standard.
1 parent e7ab87a commit 9783496

17 files changed

+85
-1094
lines changed

doc/source/api.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ File Formats
3232
nifti2
3333
ecat
3434
parrec
35+
streamlines
3536
trackvis
3637

37-
3838
Image Utilities
3939
===============
4040

doc/source/conf.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,7 @@
6161
'sphinx.ext.autosummary',
6262
'texext.math_dollar', # has to go before numpydoc
6363
'numpydoc',
64-
'only_directives',
65-
'plot_directive',
64+
'matplotlib.sphinxext.plot_directive',
6665
]
6766

6867
# the following doesn't work with sphinx < 1.0, but will make a separate

doc/source/devel/advanced_testing.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@
99
1010
.. _advanced_testing:
1111

12-
************
12+
****************
1313
Advanced Testing
14-
************
14+
****************
1515

1616
Setup
1717
-----
1818

19-
Before running advanced tests, please update all submodules of nibabel, by running ``git submodule update --init``
20-
19+
Before running advanced tests, please update all submodules of nibabel, by
20+
running ``git submodule update --init``
2121

2222
Long-running tests
2323
------------------
2424

2525
Long-running tests are not enabled by default, and can be resource-intensive. To run these tests:
2626

27-
* Set environment variable ``NIPY_EXTRA_TESTS=slow``
27+
* Set environment variable ``NIPY_EXTRA_TESTS=slow``;
2828
* Run ``nosetests``.
2929

3030
Note that some tests may require a machine with >4GB of RAM.

doc/source/installation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ setup.py install``.
2727
Installer and packages
2828
======================
2929

30-
.. _install_pypi:
30+
.. _install-pypi:
3131

3232
pip and the Python package index
3333
--------------------------------

doc/sphinxext/README.txt

-25
This file was deleted.

doc/sphinxext/ipython_console_highlighting.py

-106
This file was deleted.

doc/sphinxext/only_directives.py

-71
This file was deleted.

0 commit comments

Comments
 (0)