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.8.0.tar.gz (20.5 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: numpydoc-0.8.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for numpydoc-0.8.0.tar.gz
Algorithm Hash digest
SHA256 61f4bf030937b60daa3262e421775838c945dcdd671f37b69e8e4854c7eb5ffd
MD5 9ee991a3e3b44c955c868d80e1ea7630
BLAKE2b-256 95a8b4706a6270f0475541c5c1ee3373c7a3b793936ec1f517f1a1dab4f896c0

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