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

Uploaded Source

File details

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

File metadata

  • Download URL: numpydoc-0.9.2.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.22.0 setuptools/42.0.2.post20191203 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.3

File hashes

Hashes for numpydoc-0.9.2.tar.gz
Algorithm Hash digest
SHA256 9140669e6b915f42c6ce7fef704483ba9b0aaa9ac8e425ea89c76fe40478f642
MD5 d3320d808b8776727bac05b32fb24c82
BLAKE2b-256 b0704d8c3f9f6783a57ac9cc7a076e5610c0cc4a96af543cafc9247ac307fbfe

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