Skip to main content

Sphinx extension for enhanced autodoc API entry styling (badges and cards)

Project description

sphinx-autodoc-api-style

Sphinx extension that adds type and modifier badges and card-style containers to standard Python domain autodoc entries (functions, classes, methods, properties, attributes, data, exceptions).

Install

$ pip install sphinx-autodoc-api-style

Usage

extensions = ["sphinx_autodoc_api_style"]

No special directives are required — existing .. autofunction::, .. autoclass::, and related directives receive badges automatically.

Documentation

See the full documentation for demos and the badge reference.

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

sphinx_autodoc_api_style-0.0.1a7.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_autodoc_api_style-0.0.1a7-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_autodoc_api_style-0.0.1a7.tar.gz.

File metadata

File hashes

Hashes for sphinx_autodoc_api_style-0.0.1a7.tar.gz
Algorithm Hash digest
SHA256 8860616f0af7c8bfd340f65008c994e30bbf73a6fd3d851b3f181fceb664580a
MD5 27660e892bb1b4c2842145c77991cb90
BLAKE2b-256 a2baac334df39fe2f25f7d5aa5bfc3cfe3ff1cda611f233bcd12118809fba564

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_api_style-0.0.1a7.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_autodoc_api_style-0.0.1a7-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autodoc_api_style-0.0.1a7-py3-none-any.whl
Algorithm Hash digest
SHA256 4627a148bab6889a0e2ec1b93c4ab12ee0438f04d6c8fbc350eda5c571f531cc
MD5 cb02af672468ae19ee24042abb75bafe
BLAKE2b-256 e8a3ffb88b803d88374d2a0a361c5b82819a6e0fcbeebe16d368f81750dbc7a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_api_style-0.0.1a7-py3-none-any.whl:

Publisher: release.yml on git-pull/gp-sphinx

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