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.10+ 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.10.0.tar.gz (94.0 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.10.0-py3-none-any.whl (69.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for numpydoc-1.10.0.tar.gz
Algorithm Hash digest
SHA256 3f7970f6eee30912260a6b31ac72bba2432830cd6722569ec17ee8d3ef5ffa01
MD5 5e0a62b9440b18bf79841edb640fc21b
BLAKE2b-256 e93cdfccc9e7dee357fb2aa13c3890d952a370dd0ed071e0f7ed62ed0df567c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for numpydoc-1.10.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.10.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for numpydoc-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3149da9874af890bcc2a82ef7aae5484e5aa81cb2778f08e3c307ba6d963721b
MD5 855661ec977b95e04aaf237e2e1a3eb9
BLAKE2b-256 625e3a6a3e90f35cea3853c45e5d5fb9b7192ce4384616f932cf7591298ab6e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for numpydoc-1.10.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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page