Skip to main content

Sphinx extension to support docstrings in Numpy format

Project description

Documentation Status https://codecov.io/gh/numpy/numpydoc/branch/main/graph/badge.svg https://github.com/numpy/numpydoc/actions/workflows/test.yml/badge.svg?branch=main

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.9+ and sphinx 6+.

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

Uploaded Source

Built Distribution

numpydoc-1.8.0-py3-none-any.whl (64.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: numpydoc-1.8.0.tar.gz
  • Upload date:
  • Size: 90.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for numpydoc-1.8.0.tar.gz
Algorithm Hash digest
SHA256 022390ab7464a44f8737f79f8b31ce1d3cfa4b4af79ccaa1aac5e8368db587fb
MD5 f1dcf7f9e10d72680a6ff71607cce99b
BLAKE2b-256 ee595d1d1afb0b9598e21e7cda477935188e39ef845bcf59cb65ac20845bfd45

See more details on using hashes here.

File details

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

File metadata

  • Download URL: numpydoc-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 64.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for numpydoc-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72024c7fd5e17375dec3608a27c03303e8ad00c81292667955c6fea7a3ccf541
MD5 02f36a85d3229f9e2c20a1479a7f690f
BLAKE2b-256 6c4556d99ba9366476cd8548527667f01869279cedb9e66b28eb4dfb27701679

See more details on using hashes here.

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