diff options
| author | Pauli Virtanen <pav@iki.fi> | 2009-07-18 23:06:38 +0000 |
|---|---|---|
| committer | Pauli Virtanen <pav@iki.fi> | 2009-07-18 23:06:38 +0000 |
| commit | db04d104ec45a1f7893f9d35a4c371eb21f517b1 (patch) | |
| tree | 6ed4827d927a48c142ea2c48a6e6df08197e0d83 /doc/sphinxext/README.txt | |
| parent | a44e1438cc156d24bfdaa80f5007bc16f6e88418 (diff) | |
| download | numpy-db04d104ec45a1f7893f9d35a4c371eb21f517b1.tar.gz | |
numpydoc: add np-* directives
Diffstat (limited to 'doc/sphinxext/README.txt')
| -rw-r--r-- | doc/sphinxext/README.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/sphinxext/README.txt b/doc/sphinxext/README.txt index d001e5d3b..96477033b 100644 --- a/doc/sphinxext/README.txt +++ b/doc/sphinxext/README.txt @@ -8,7 +8,9 @@ of them in third-party projects. The following extensions are available: - - ``numpydoc``: support for the Numpy docstring format in Sphinx. + - ``numpydoc``: support for the Numpy docstring format in Sphinx, and add + the code description directives ``np-function``, ``np-cfunction``, etc. + that support the Numpy docstring syntax. - ``numpydoc.traitsdoc``: For gathering documentation about Traits attributes. |