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

Uploaded Source

Built Distribution

numpydoc-1.9.0-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: numpydoc-1.9.0.tar.gz
  • Upload date:
  • Size: 91.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for numpydoc-1.9.0.tar.gz
Algorithm Hash digest
SHA256 5fec64908fe041acc4b3afc2a32c49aab1540cf581876f5563d68bb129e27c5b
MD5 f84db6e9fdd4c4ea88d40eaeeeff5196
BLAKE2b-256 2f197721093e25804cc82c7c1cdab0cce6b9343451828fc2ce249cee10646db5

See more details on using hashes here.

Provenance

The following attestation bundles were made for numpydoc-1.9.0.tar.gz:

Publisher: release.yml on numpy/numpydoc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: numpydoc-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 64.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for numpydoc-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a2983b2d62bfd0a8c470c7caa25e7e0c3d163875cdec12a8a1034020a9d1135
MD5 e326cb0ce1d1709d90ba0a3c3787279b
BLAKE2b-256 26625783d8924fca72529defb2c7dbe2070d49224d2dba03a85b20b37adb24d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for numpydoc-1.9.0-py3-none-any.whl:

Publisher: release.yml on numpy/numpydoc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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