Skip to main content
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.8+ and sphinx 5+.

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.

Release files for numpydoc 1.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for numpydoc 1.7.0
File Size Uploaded
numpydoc-1.7.0.tar.gz 87.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for numpydoc 1.7.0
File Interpreter ABI Platform
numpydoc-1.7.0-py3-none-any.whl Python 3 none any Details

Total release size:150.4 kB

Release files / numpydoc-1.7.0.tar.gz

Download URL numpydoc-1.7.0.tar.gz
Size 87.6 kB
Tags Source
SHA-256 checksum
How to use checksums
866e5ae5b6509dcf873fc6381120f5c31acf13b135636c1a81d68c166a95f921
BLAKE2b-256 checksum
How to use checksums
7669d745d43617a476a5b5fb7f71555eceaca32e23296773c35decefa1da5463
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.2

Release files / numpydoc-1.7.0-py3-none-any.whl

Download URL numpydoc-1.7.0-py3-none-any.whl
Size 62.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5a56419d931310d79a06cfc2a126d1558700feeb9b4f3d8dcae1a8134be829c9
BLAKE2b-256 checksum
How to use checksums
f0fadcfe0f65660661db757ee9ebd84e170ff98edd5d80235f62457d9088f85f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.2

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page