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 3.0+.

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

This version

1.4.0rc1 pre-release

1.3.1

1.3

1.3rc1 pre-release

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.4.0rc1.tar.gz (69.8 kB view details)

Uploaded Source

Built Distribution

numpydoc-1.4.0rc1-py3-none-any.whl (52.0 kB view details)

Uploaded Python 3

File details

Details for the file numpydoc-1.4.0rc1.tar.gz.

File metadata

  • Download URL: numpydoc-1.4.0rc1.tar.gz
  • Upload date:
  • Size: 69.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.9

File hashes

Hashes for numpydoc-1.4.0rc1.tar.gz
Algorithm Hash digest
SHA256 f8fd1af7954d0295fa7e222b74372f05cd7b0c0f46b5e5120102f62b7b00c07a
MD5 c4e976b66611b51955def7fbc84e789d
BLAKE2b-256 3ed51b658722983c5935d4f41d7b7d73795acd62c25075d6281c302e54b89045

See more details on using hashes here.

Provenance

File details

Details for the file numpydoc-1.4.0rc1-py3-none-any.whl.

File metadata

  • Download URL: numpydoc-1.4.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 52.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.9

File hashes

Hashes for numpydoc-1.4.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 3b5452f1a0fceff6e8825f9110f1e7677cc9cbbba6180fb84000478d1edfdab4
MD5 13fe700f2ffaacd63c53ad6330d3a9e4
BLAKE2b-256 ac3da51f2043bbe747a249060268dc3d779cf1da77e5828f8919b2fcaaf8f7bd

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