Sphinx extension to support docstrings in Numpy format

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Eric89GXL from gravatar.com Eric89GXL Avatar for jarrodmillman from gravatar.com jarrodmillman Avatar for jnothman from gravatar.com jnothman Avatar for pv from gravatar.com pv Avatar for rgommers from gravatar.com rgommers

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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.7+ and sphinx 1.8+.

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Eric89GXL from gravatar.com Eric89GXL Avatar for jarrodmillman from gravatar.com jarrodmillman Avatar for jnothman from gravatar.com jnothman Avatar for pv from gravatar.com pv Avatar for rgommers from gravatar.com rgommers

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

1.8.0

1.8.0rc2 pre-release

1.8.0rc1 pre-release

1.7.0

1.7.0rc0 pre-release

1.6.0

1.6.0rc2 pre-release

1.6.0rc1 pre-release

1.6.0rc0 pre-release

1.5.0

1.5.0rc1 pre-release

1.4.0

1.4.0rc1 pre-release

1.3.1

1.3

1.3rc1 pre-release

This version

1.2.1

1.2

1.2rc1 pre-release

1.1.0

1.0.0

0.9.2

0.9.1

0.9.0

0.8.0

0.7.0

0.6.0

0.5

0.4

0.3.1

0.2

0.1

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

Uploaded Source

Built Distribution

numpydoc-1.2.1-py3-none-any.whl (51.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: numpydoc-1.2.1.tar.gz
  • Upload date:
  • Size: 70.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.9

File hashes

Hashes for numpydoc-1.2.1.tar.gz
Algorithm Hash digest
SHA256 7ce826ed0d54c3fdc9097992a8d73a4d459dc468611351c68e444fec44a45af6
MD5 560d349544b6102029918d86c67fea73
BLAKE2b-256 9c8febc93df00a70b2ee298a2e67138d54adfb1ae5a3fb267d6d1f9b9c99293e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: numpydoc-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 51.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.9

File hashes

Hashes for numpydoc-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2d317df5fd9404a5199bb993c1b6627436b2804582d2775bf9ccf3c5912ebe99
MD5 7fcdd8777e97b722da528eb9ec7e5085
BLAKE2b-256 fb2cb8ea78c28367808278e6a61885384dce4157e700db4aac655f7c2e509a08

See more details on using hashes here.

Provenance

Supported by

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