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.11.0rc0.tar.gz (96.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.11.0rc0-py3-none-any.whl (71.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: numpydoc-1.11.0rc0.tar.gz
  • Upload date:
  • Size: 96.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for numpydoc-1.11.0rc0.tar.gz
Algorithm Hash digest
SHA256 f394cb211ad319c27a5927131117a485ff90cc53d131e744053ddc303e76a7ac
MD5 7eb852db18e84167d0793d53c96a2a8a
BLAKE2b-256 7567144cb738b446308e55671e8fde9c6189f1dd5a6558b00cef69206a4f80dd

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for numpydoc-1.11.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 d5c6822d70ba2d329e8572bd9edbcbae8b66c443a1be2850e3b2c6976635750c
MD5 fca229ef4a34d5605c2db06470e97864
BLAKE2b-256 68bfe16b5200d42e5b6a8be28e9f950df44f0555f7a6faf641752dc8a62c610b

See more details on using hashes here.

Provenance

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