Sphinx extension to support docstrings in Numpy format

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Eric89GXL from gravatar.com Eric89GXL Avatar for jarrodmillman from gravatar.com jarrodmillman Avatar for jnothman from gravatar.com jnothman Avatar for pv from gravatar.com pv Avatar for rgommers from gravatar.com rgommers

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Eric89GXL from gravatar.com Eric89GXL Avatar for jarrodmillman from gravatar.com jarrodmillman Avatar for jnothman from gravatar.com jnothman Avatar for pv from gravatar.com pv Avatar for rgommers from gravatar.com rgommers

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

1.8.0

1.8.0rc2 pre-release

1.8.0rc1 pre-release

1.7.0

1.7.0rc0 pre-release

1.6.0

1.6.0rc2 pre-release

1.6.0rc1 pre-release

1.6.0rc0 pre-release

1.5.0

1.5.0rc1 pre-release

1.4.0

1.4.0rc1 pre-release

1.3.1

1.3

1.3rc1 pre-release

1.2.1

1.2

1.2rc1 pre-release

1.1.0

This version

1.0.0

0.9.2

0.9.1

0.9.0

0.8.0

0.7.0

0.6.0

0.5

0.4

0.3.1

0.2

0.1

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

Uploaded Source

Built Distribution

numpydoc-1.0.0-py3-none-any.whl (47.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: numpydoc-1.0.0.tar.gz
  • Upload date:
  • Size: 42.2 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.0.0.tar.gz
Algorithm Hash digest
SHA256 e481c0799dfda208b6a2c2cb28757fa6b6cbc4d6e43722173697996cf556df7f
MD5 3aa157caf6d18bb42be0ce8d624c6406
BLAKE2b-256 65004a01d67ded6af80f898b2ec5f8196b741f03ad7ef441fa2e7e4055d72080

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: numpydoc-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 47.4 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 99e9c4ec51ff0dc17f7e15afcb26ba77a2f8ccc85a19dede40006a2b93cc903f
MD5 bde41be97dc3d9520f98b2e48d836997
BLAKE2b-256 3a432402fd1f63992a52f88e3b169d59674617013bf7f1ad0cd7d842eafd0c58

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