Skip to main content

Sphinx extension to support docstrings in Numpy format

Project description

https://travis-ci.org/numpy/numpydoc.png?branch=master

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 following extensions are available:

  • numpydoc: support for the Numpy docstring format in Sphinx, and add the code description directives np:function, np-c:function, etc. that support the Numpy docstring syntax.
  • numpydoc.traitsdoc: For gathering documentation about Traits attributes.
  • numpydoc.plot_directive: Adaptation of Matplotlib’s plot:: directive. Note that this implementation may still undergo severe changes or eventually be deprecated.

See A Guide to NumPy/SciPy Documentation for how to write docs that use this extension.

numpydoc

Numpydoc inserts a hook into Sphinx’s autodoc that converts docstrings following the Numpy/Scipy format to a form palatable to Sphinx.

Options

The following options can be set in conf.py:

  • numpydoc_use_plots: bool

    Whether to produce plot:: directives for Examples sections that contain import matplotlib.

  • numpydoc_show_class_members: bool

    Whether to show all members of a class in the Methods and Attributes sections automatically.

  • numpydoc_class_members_toctree: bool

    Whether to create a Sphinx table of contents for the lists of class methods and attributes. If a table of contents is made, Sphinx expects each entry to have a separate page.

  • numpydoc_edit_link: bool (DEPRECATED – edit your HTML template instead)

    Whether to insert an edit link after docstrings.

Project details


Release history Release notifications

History Node

0.8.0

History Node

0.7.0

History Node

0.6.0

This version
History Node

0.5

History Node

0.4

History Node

0.3.1

History Node

0.2

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
numpydoc-0.5.tar.gz (32.1 kB) Copy SHA256 hash SHA256 Source None Jun 8, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page