8000 Added documentation on numpydoc · matplotlib/matplotlib@2ca2664 · GitHub
[go: up one dir, main page]

Skip to content

Commit 2ca2664

Browse files
committed
Added documentation on numpydoc
1 parent be25439 commit 2ca2664

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

doc/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@
3434
'numpy_ext.numpydoc']
3535

3636

37+
try:
38+
import numpydoc
39+
except ImportError:
40+
raise ImportError("No modyle named numpydoc - you need to install "
41+
"numpydoc to build the documentation.")
42+
43+
3744
autosummary_generate = True
3845

3946
if sphinx.__version__ >= 1.1:

doc/devel/documenting_mpl.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Documenting matplotlib
77
Getting started
88
===============
99

10-
The documentation for matplotlib is generated from ReStructured Text
11-
using the Sphinx_ documentation generation tool. Sphinx-1.0 or later
12-
is required.
10+
The documentation for matplotlib is generated from ReStructured Text using the
11+
Sphinx_ documentation generation tool. Sphinx-1.0 or later and numpydoc 0.4 or
12+
later is required.
1313

1414
The documentation sources are found in the :file:`doc/` directory in
1515
the trunk. To build the users guide in html format, cd into

0 commit comments

Comments
 (0)
0