Migrate files to repo-config 0.12

Run the migration script from repo-config 0.12.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

docs/_scripts/macros.py

@@ -3,79 +3,18 @@
 
 """This module defines macros for use in Markdown files."""
 
-from typing import Any
-
-import markdown as md
+from frequenz.repo.config.mkdocs.mkdocstrings_macros import hook_env_with_everything
 from griffe import ModulesCollection, Object
-from markdown.extensions import toc
-from mkdocs_macros import plugin as macros
+from mkdocs_macros.plugin import MacrosPlugin
 from mkdocstrings_handlers.python.handler import PythonHandler
 
-_CODE_ANNOTATION_MARKER: str = (
-    r'<span class="md-annotation">'
-    r'<span class="md-annotation__index" tabindex="-1">'
-    r'<span data-md-annotation-id="1"></span>'
-    r"</span>"
-    r"</span>"
-)
-
-
-def _slugify(text: str) -> str:
-    """Slugify a text.
-
-    Args:
-        text: The text to slugify.
-
-    Returns:
-        The slugified text.
-    """
-    return toc.slugify_unicode(text, "-")
-
-
-def _hook_macros_plugin(env: macros.MacrosPlugin) -> None:
-    """Integrate the `mkdocs-macros` plugin into `mkdocstrings`.
-
-    This is a temporary workaround to make `mkdocs-macros` work with
-    `mkdocstrings` until a proper `mkdocs-macros` *pluglet* is available. See
-    https://github.com/mkdocstrings/mkdocstrings/issues/615 for details.
-
-    Args:
-        env: The environment to hook the plugin into.
-    """
-    # get mkdocstrings' Python handler
-    python_handler = env.conf["plugins"]["mkdocstrings"].get_handler("python")
-
-    # get the `update_env` method of the Python handler
-    update_env = python_handler.update_env
-
-    # override the `update_env` method of the Python handler
-    def patched_update_env(markdown: md.Markdown, config: dict[str, Any]) -> None:
-        update_env(markdown, config)
-
-        # get the `convert_markdown` filter of the env
-        convert_markdown = python_handler.env.filters["convert_markdown"]
 
-        # build a chimera made of macros+mkdocstrings
-        def render_convert(markdown: str, *args: Any, **kwargs: Any) -> Any:
-            return convert_markdown(env.render(markdown), *args, **kwargs)
-
-        # patch the filter
-        python_handler.env.filters["convert_markdown"] = render_convert
-
-    # patch the method
-    python_handler.update_env = patched_update_env
-
-
-def define_env(env: macros.MacrosPlugin) -> None:
+def define_env(env: MacrosPlugin) -> None:
     """Define the hook to create macro functions for use in Markdown.
 
     Args:
         env: The environment to define the macro functions in.
     """
-    # A variable to easily show an example code annotation from mkdocs-material.
-    # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations
-    env.variables["code_annotation_marker"] = _CODE_ANNOTATION_MARKER
-
     python_handler = env.conf["plugins"]["mkdocstrings"].get_handler("python")
     assert isinstance(python_handler, PythonHandler)
 
@@ -108,9 +47,10 @@ def docstring_summary(symbol: str) -> str:
         """
         docstring = _get_docstring(symbol)
         summary = docstring.splitlines(keepends=False)[0]
-        return python_handler.do_convert_markdown(
+        # The python_handler is untyped here, so ignore the type
+        return python_handler.do_convert_markdown(  # type: ignore[no-any-return]
             summary, heading_level=1, strip_paragraph=True
         )
 
-    # This hook needs to be done at the end of the `define_env` function.
-    _hook_macros_plugin(env)
+    # This must be at the end to enable all standard features
+    hook_env_with_everything(env)

pyproject.toml

@@ -148,6 +148,7 @@ disable = [
 ]
 
 [tool.pytest.ini_options]
+addopts = "-W=all -Werror -Wdefault::DeprecationWarning -Wdefault::PendingDeprecationWarning -vv"
 testpaths = ["tests", "src"]
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"