griffe-warnings-deprecated
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.
Sponsors
Silver sponsors
Bronze sponsors
And 4 more private sponsor(s).
1 maintainer
Metadata
1 maintainer
Release files for griffe-warnings-deprecated 1.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| griffe_warnings_deprecated-1.1.2.tar.gz | 32.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| griffe_warnings_deprecated-1.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 42.8 kB
Release files / griffe_warnings_deprecated-1.1.2.tar.gz
| Download URL | griffe_warnings_deprecated-1.1.2.tar.gz |
|---|---|
| Size | 32.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3d57519749cd3225a483780c325cda242f7ac3dd8af70bfed0b4d0e2e20a15df
|
|
BLAKE2b-256 checksum How to use checksums |
637b7b1cf0e858e9370a957e50f59f5123b0188e0a5dba17b22cf6adac044a71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / griffe_warnings_deprecated-1.1.2-py3-none-any.whl
| Download URL | griffe_warnings_deprecated-1.1.2-py3-none-any.whl |
|---|---|
| Size | 10.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a49ff05e057694ae5a141d0bc1bb30d1a06694abc7cf0c3f3504aa8a0e9313f2
|
|
BLAKE2b-256 checksum How to use checksums |
55614f63b56a06ca2b85834fef891231ad78c55a65cd8145afe19d43764bb393
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
