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

This package provides the numpydoc Sphinx extension for handling docstrings formatted according to the NumPy documentation format. The extension also adds the code description directives np:function, np-c:function, etc.

numpydoc requires Python 3.5+ and sphinx 1.6.5+.

For usage information, please refer to the documentation.

The numpydoc docstring guide explains how to write docs formatted for this extension, and the user guide explains how to use it with Sphinx.

Project details


Download files

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

Files for numpydoc, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size numpydoc-1.1.0-py3-none-any.whl (47.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size numpydoc-1.1.0.tar.gz (609.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page