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.

Source Distribution

numpydoc-1.1.0.tar.gz (609.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

numpydoc-1.1.0-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: numpydoc-1.1.0.tar.gz
  • Upload date:
  • Size: 609.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.8.2

File hashes

Hashes for numpydoc-1.1.0.tar.gz
Algorithm Hash digest
SHA256 c36fd6cb7ffdc9b4e165a43f67bf6271a7b024d0bb6b00ac468c9e2bfc76448e
MD5 2f05c4592e007b7a1fa37ddcb7e0e91b
BLAKE2b-256 3dfba70f636102045fc646656f2221c7fcdf92f7a9d71ba7c9875a949a58b3e8

See more details on using hashes here.

File details

Details for the file numpydoc-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: numpydoc-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.8.2

File hashes

Hashes for numpydoc-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c53d6311190b9e3b9285bc979390ba0257ba9acde5eca1a7065fc8dfca9d46e8
MD5 e0937935512dbd55e1759d66fe5f108b
BLAKE2b-256 601d9e398c53d6ae27d5ab312ddc16a9ffe1bee0dfdf1d6ec88c40b0ca97582e

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