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.

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.

Source Distribution

numpydoc-0.9.1.tar.gz (27.6 kB view details)

Uploaded Source

File details

Details for the file numpydoc-0.9.1.tar.gz.

File metadata

  • Download URL: numpydoc-0.9.1.tar.gz
  • Upload date:
  • Size: 27.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for numpydoc-0.9.1.tar.gz
Algorithm Hash digest
SHA256 e08f8ee92933e324ff347771da15e498dbf0bc6295ed15003872b34654a0a627
MD5 70d39e051e5c5d02fdd10ad0a8ef7680
BLAKE2b-256 6af37cfe4c616e4b9fe05540256cc9c6661c052c8a4cec2915732793b36e1843

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page