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

Uploaded Source

File details

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

File metadata

  • Download URL: numpydoc-0.9.0.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.0.tar.gz
Algorithm Hash digest
SHA256 45e897ffc7f3e6962f6a02ea996d1661d99011f3d68fee450dc33056b60da84e
MD5 0956677fc81b2dc51730a9898d063b25
BLAKE2b-256 9f58a877c532f90066a415a139b51af0ea1e1336893bdbb5686e75ad9a6f98cc

See more details on using hashes here.

Supported by

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