diff --git a/docs/_css/mkdocstrings.css b/docs/_css/mkdocstrings.css index 572abff1..851214f2 100644 --- a/docs/_css/mkdocstrings.css +++ b/docs/_css/mkdocstrings.css @@ -42,3 +42,25 @@ a.autorefs-external::after { a.autorefs-external:hover::after { background-color: var(--md-accent-fg-color); } + +/* A "Deprecated" admonition, styled like a warning but with its own icon. */ +:root { + --md-admonition-icon--deprecated: url('data:image/svg+xml;charset=utf-8,'); +} + +.md-typeset .admonition.deprecated, +.md-typeset details.deprecated { + border-color: #cc9900; +} + +.md-typeset .deprecated > .admonition-title, +.md-typeset .deprecated > summary { + background-color: #cc99001a; +} + +.md-typeset .deprecated > .admonition-title::before, +.md-typeset .deprecated > summary::before { + background-color: #cc9900; + -webkit-mask-image: var(--md-admonition-icon--deprecated); + mask-image: var(--md-admonition-icon--deprecated); +} diff --git a/mkdocs.yml b/mkdocs.yml index 97524e82..694788df 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -101,6 +101,10 @@ plugins: python: paths: ["src"] options: + extensions: + - griffe_warnings_deprecated: + kind: deprecated + title: Deprecated docstring_section_style: spacy inherited_members: true merge_init_into_class: false diff --git a/pyproject.toml b/pyproject.toml index 8f946b8c..4e4132c9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -72,6 +72,7 @@ dev-flake8 = [ dev-formatting = ["black == 26.5.1", "isort == 9.0.1"] dev-mkdocs = [ "black == 26.5.1", + "griffe-warnings-deprecated == 1.1.1", "Markdown == 3.10.3", "mike == 2.2.0", "mkdocs-gen-files == 0.6.1", diff --git a/src/frequenz/client/dispatch/_client.py b/src/frequenz/client/dispatch/_client.py index 9381c4e9..a3150fdc 100644 --- a/src/frequenz/client/dispatch/_client.py +++ b/src/frequenz/client/dispatch/_client.py @@ -69,6 +69,10 @@ def __init__( ) -> None: """Initialize the client. + Deprecated: + The `key` argument is deprecated since v0.11.2. Pass `auth_key` + instead. + Args: server_url: The URL of the server to connect to. auth_key: API key to use for authentication. diff --git a/src/frequenz/client/dispatch/types.py b/src/frequenz/client/dispatch/types.py index be954371..709cb097 100644 --- a/src/frequenz/client/dispatch/types.py +++ b/src/frequenz/client/dispatch/types.py @@ -106,7 +106,12 @@ class InverterType(Enum): """Solar inverter.""" SOLAR = PBInverterType.INVERTER_TYPE_PV - """Deprecated, Solar inverter.""" + """Solar inverter (deprecated). + + Deprecated: + This member is deprecated since v0.11.2. Use + [`PV`][frequenz.client.dispatch.types.InverterType.PV] instead. + """ HYBRID = PBInverterType.INVERTER_TYPE_HYBRID """Hybrid inverter."""