Skip to main content

Griffe extension for `@warnings.deprecated` (PEP 702).

Project description

griffe-warnings-deprecated

ci documentation pypi version gitpod gitter

Griffe extension for @warnings.deprecated (PEP 702).

Installation

pip install griffe-warnings-deprecated

Usage

The option values in the following examples are the default ones, you can omit them if you like the defaults.

Command-line

griffe dump mypackage -e griffe_warnings_deprecated

See command-line usage in Griffe's documentation.

Python

import griffe

griffe.load(
    "mypackage",
    extensions=griffe.load_extensions(
        [{"griffe_warnings_deprecated": {
            "kind": "danger",
            "title": "Deprecated",
            "label": "deprecated"
        }}]
    )
)

See programmatic usage in Griffe's documentation.

MkDocs

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_warnings_deprecated:
              kind: danger
              title: Deprecated

See MkDocs usage in Griffe's documentation.


Options:

  • kind: The admonition kind (default: danger).
  • title: The admonition title (default: Deprecated). Can be set to null to use the message as title.
  • label: The label added to deprecated objects (default: deprecated). Can be set to null.

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

griffe_warnings_deprecated-1.0.0.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file griffe_warnings_deprecated-1.0.0.tar.gz.

File metadata

File hashes

Hashes for griffe_warnings_deprecated-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f5af502062ebd95ac8991ad4c76bda03e5390aa5871e869ab4b7c1b9e83d45b8
MD5 7705782c57909c9e709606598bc64850
BLAKE2b-256 9876c4c35d70773738b0b9acb05f30597e9784d6d34defc3e6b66d7d3330beff

See more details on using hashes here.

File details

Details for the file griffe_warnings_deprecated-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for griffe_warnings_deprecated-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 027915ff971ec5ab3fa666c0270d79eb0f2e1b3f4e01e16c9e2226d80d18a7ab
MD5 5f95b1273d9cd4b769500c8b828fbd06
BLAKE2b-256 736c24d0a2076dd4d12a506e5b363f8183afa07faad048baecc1df5e66733d5d

See more details on using hashes here.

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