File: index.rst

package info (click to toggle)
numpydoc 1.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 564 kB
  • sloc: python: 4,470; makefile: 169
file content (27 lines) | stat: -rw-r--r-- 790 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
:html_theme.sidebar_secondary.remove: true

=====================================
numpydoc -- Numpy's Sphinx extensions
=====================================

Numpy's documentation uses several custom extensions to Sphinx.  These
are shipped in this ``numpydoc`` package, in case you want to make use
of them in third-party projects.

The ``numpydoc`` extension provides support for the Numpy docstring format in
Sphinx, and adds the code description directives ``np:function``,
``np-c:function``, etc.  that support the Numpy docstring syntax.

- Development: https://github.com/numpy/numpydoc/
- Documentation: https://numpydoc.readthedocs.io/
- PyPI: https://pypi.python.org/pypi/numpydoc/


.. toctree::
    :hidden:

    install
    format
    validation
    release/index
    example