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.0rc0.tar.gz (90.6 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.9.0rc0-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: numpydoc-1.9.0rc0.tar.gz
  • Upload date:
  • Size: 90.6 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.0rc0.tar.gz
Algorithm Hash digest
SHA256 6b29f7fe696db9810075c14c0527602eefb29439d3e806decc2ccb95c7deac3b
MD5 343661df453f0201b9d20a5e45f5516c
BLAKE2b-256 2be3ba84ed93cf214e1cdf0161c1237607a7445ed571f0d34a08e633477fd165

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: numpydoc-1.9.0rc0-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.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 7fe725ec723633b7d6e9ce9c4c970f5f8683e3825284b0f9fbe46201187ae40d
MD5 f393ee7e59e8c4768e36978b29de7909
BLAKE2b-256 e5c96fd2fde902efe88aa177018b99bd199fb48570d99048e481e1356cea7a6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for numpydoc-1.9.0rc0-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