Deployed 8e7c2bb with MkDocs version: 1.6.1

Author: pawamoy

changelog/index.html

@@ -12,7 +12,7 @@
 coviframe.contentWindow.document.body.onclick = function() {
     coviframe.contentWindow.location.reload();
 }
-</script> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="September 9, 2025 11:17:27 UTC"><span class=timeago datetime=2025-09-09T11:17:27+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="September 9, 2025 11:17:27 UTC">2025-09-09</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="September 9, 2025 11:17:27 UTC"><span class=timeago datetime=2025-09-09T11:17:27+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="September 9, 2025 11:17:27 UTC">2025-09-09</span> </span> </aside> <form class=md-feedback name=feedback hidden> <fieldset> <legend class=md-feedback__title> Was this page helpful? </legend> <div class=md-feedback__inner> <div class=md-feedback__list> <button class="md-feedback__icon md-icon" type=submit title="This page was helpful" data-md-value=1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"/></svg> </button> <button class="md-feedback__icon md-icon" type=submit title="This page could be improved" data-md-value=0> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10m-6.5-4c.8 0 1.5.7 1.5 1.5s-.7 1.5-1.5 1.5-1.5-.7-1.5-1.5.7-1.5 1.5-1.5M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m2 4.5c1.75 0 3.29.72 4.19 1.81l-1.42 1.42C14.32 16.5 13.25 16 12 16s-2.32.5-2.77 1.23l-1.42-1.42C8.71 14.72 10.25 14 12 14"/></svg> </button> </div> <div class=md-feedback__note> <div data-md-value=1 hidden> Thanks for your feedback! </div> <div data-md-value=0 hidden> Let us know how we can improve this page. </div> </div> </div> </fieldset> </form> <!-- Giscus --> <!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration --> <div id=feedback style="display: none;"> <h2 id=__comments>Feedback</h2> <script src=https://giscus.app/client.js data-repo=mkdocstrings/griffe2md data-repo-id=R_kgDOJh3AFw data-category=Documentation data-category-id=DIC_kwDOJh3AF84Chq0j data-mapping=pathname data-strict=1 data-reactions-enabled=0 data-emit-metadata=0 data-input-position=top data-theme=preferred_color_scheme data-lang=en data-loading=lazy crossorigin=anonymous async>
+</script> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="September 24, 2025 14:17:06 UTC"><span class=timeago datetime=2025-09-24T14:17:06+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="September 24, 2025 14:17:06 UTC">2025-09-24</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="September 24, 2025 14:17:06 UTC"><span class=timeago datetime=2025-09-24T14:17:06+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="September 24, 2025 14:17:06 UTC">2025-09-24</span> </span> </aside> <form class=md-feedback name=feedback hidden> <fieldset> <legend class=md-feedback__title> Was this page helpful? </legend> <div class=md-feedback__inner> <div class=md-feedback__list> <button class="md-feedback__icon md-icon" type=submit title="This page was helpful" data-md-value=1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"/></svg> </button> <button class="md-feedback__icon md-icon" type=submit title="This page could be improved" data-md-value=0> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10m-6.5-4c.8 0 1.5.7 1.5 1.5s-.7 1.5-1.5 1.5-1.5-.7-1.5-1.5.7-1.5 1.5-1.5M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m2 4.5c1.75 0 3.29.72 4.19 1.81l-1.42 1.42C14.32 16.5 13.25 16 12 16s-2.32.5-2.77 1.23l-1.42-1.42C8.71 14.72 10.25 14 12 14"/></svg> </button> </div> <div class=md-feedback__note> <div data-md-value=1 hidden> Thanks for your feedback! </div> <div data-md-value=0 hidden> Let us know how we can improve this page. </div> </div> </div> </fieldset> </form> <!-- Giscus --> <!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration --> <div id=feedback style="display: none;"> <h2 id=__comments>Feedback</h2> <script src=https://giscus.app/client.js data-repo=mkdocstrings/griffe2md data-repo-id=R_kgDOJh3AFw data-category=Documentation data-category-id=DIC_kwDOJh3AF84Chq0j data-mapping=pathname data-strict=1 data-reactions-enabled=0 data-emit-metadata=0 data-input-position=top data-theme=preferred_color_scheme data-lang=en data-loading=lazy crossorigin=anonymous async>
     </script> <!-- Synchronize Giscus theme with palette --> <script>
         var giscus = document.querySelector("script[src*=giscus]")
 

coverage/index.html

@@ -152,10 +152,13 @@ default_config: ConfigDict = {
     "preload_modules": None,
     "load_external_modules": False,
     "allow_inspection": True,
+    "force_inspection": False,
     "summary": True,
     "show_docstring_classes": True,
     "show_docstring_functions": True,
     "show_docstring_modules": True,
+    "extensions": [],
+    "search_paths": [],
 }
 ```
 
@@ -182,10 +185,12 @@ Attributes:
 
 - **`allow_inspection`** (`bool`) – Allow using introspection on modules for which sources aren't available (compiled modules, etc.).
 - **`annotations_path`** (`Literal['brief', 'source', 'full']`) – The verbosity for annotations path: brief (recommended), source (as written in the source), or full.
-- **`docstring_options`** (`dict`) – mkdocstring configuration
+- **`docstring_options`** (`DocstringOptions`) – mkdocstring configuration
 - **`docstring_section_style`** (`Literal['list', 'table']`) – The style used to render docstring sections.
 - **`docstring_style`** (`Literal['google', 'numpy', 'sphinx', 'auto'] | None`) – The style in which docstrings are written: auto, google, numpy, sphinx, or None.
+- **`extensions`** (`list[LoadableExtensionType]`) – A list of Griffe extensions to load.
 - **`filters`** (`list[str] | list[tuple[Pattern[str], bool]]`) – A list of filters.
+- **`force_inspection`** (`bool`) – Force using introspection on modules even if sources are available.
 - **`group_by_category`** (`bool`) – Group the object's children by categories: attributes, classes, functions, and modules.
 - **`heading_level`** (`int`) – The initial heading level to use.
 - **`inherited_members`** (`bool | list[str]`) – A boolean, or an explicit list of inherited members to render.
@@ -195,6 +200,7 @@ Attributes:
 - **`members_order`** (`Literal['alphabetical', 'source']`) – The members ordering to use.
 - **`merge_init_into_class`** (`bool`) – Whether to merge the __init__ method into the class' signature and docstring.
 - **`preload_modules`** (`list[str] | None`) – Pre-load modules that are not specified directly in autodoc instructions (::: identifier).
+- **`search_paths`** (`list[str]`) – A list of paths to search packages into.
 - **`separate_signature`** (`bool`) – Whether to put the whole signature in a code block below the heading.
 - **`show_bases`** (`bool`) – Show the base classes of a class.
 - **`show_category_heading`** (`bool`) – When grouped by categories, show a heading for each category.
@@ -241,7 +247,7 @@ The verbosity for annotations path: `brief` (recommended), `source` (as written
 ### docstring_options
 
 ```
-docstring_options: dict
+docstring_options: DocstringOptions
 ```
 
 mkdocstring [configuration](https://mkdocstrings.github.io/python/usage/configuration/general/)
@@ -264,6 +270,14 @@ docstring_style: (
 
 The style in which docstrings are written: `auto`, `google`, `numpy`, `sphinx`, or `None`.
 
+### extensions
+
+```
+extensions: list[LoadableExtensionType]
+```
+
+A list of Griffe extensions to load.
+
 ### filters
 
 ```
@@ -274,6 +288,14 @@ A list of filters.
 
 A filter starting with `!` will exclude matching objects instead of including them. The `members` option takes precedence over `filters` (filters will still be applied recursively to lower members in the hierarchy).
 
+### force_inspection
+
+```
+force_inspection: bool
+```
+
+Force using introspection on modules even if sources are available.
+
 ### group_by_category
 
 ```
@@ -359,6 +381,14 @@ For an imported member to be rendered, you need to add it to the `__all__` attri
 
 The modules must be listed as an array of strings.
 
+### search_paths
+
+```
+search_paths: list[str]
+```
+
+A list of paths to search packages into.
+
 ### separate_signature
 
 ```
@@ -1473,6 +1503,10 @@ Parameters:
 - **`obj`** (`Object`) – The Griffe object to render docs for.
 - **`config`** (`ConfigDict | None`, default: `None` ) – The rendering configuration.
 
+Warning
+
+When using this function programmatically, options such as `docstring_style` and `docstring_options` must be passed to the Griffe loader so that they are correctly set when loading data. Check griffe.GriffeLoader for more information.
+
 Returns:
 
 - `str` – Markdown.
@@ -1487,6 +1521,12 @@ def render_object_docs(obj: Object, config: ConfigDict | None = None) -> str:
         obj: The Griffe object to render docs for.
         config: The rendering configuration.
 
+    Warning:
+        When using this function programmatically,
+        options such as `docstring_style` and `docstring_options` must be passed
+        to the Griffe loader so that they are correctly set when loading data.
+        Check [`griffe.GriffeLoader`][] for more information.
+
     Returns:
         Markdown.
     """
@@ -1530,7 +1570,16 @@ def render_package_docs(package: str, config: ConfigDict | None = None) -> str:
     """
     config = cast("ConfigDict", {**default_config, **(config or {})})
     parser = config["docstring_style"] and Parser(config["docstring_style"])
-    loader = GriffeLoader(docstring_parser=parser)
+    parser_options: DocstringOptions = config["docstring_options"]
+    extensions = load_extensions(*config["extensions"]) if config["extensions"] else None
+    loader = GriffeLoader(
+        extensions=extensions,
+        search_paths=config["search_paths"] + sys.path,
+        docstring_parser=parser,
+        docstring_options=parser_options,
+        allow_inspection=config["allow_inspection"],
+        force_inspection=config["force_inspection"],
+    )
     module = loader.load(package)
     loader.resolve_aliases(external=True)
     return render_object_docs(module, config)  # type: ignore[arg-type]

credits/index.html

@@ -97,10 +97,13 @@ default_config: ConfigDict = {
     "preload_modules": None,
     "load_external_modules": False,
     "allow_inspection": True,
+    "force_inspection": False,
     "summary": True,
     "show_docstring_classes": True,
     "show_docstring_functions": True,
     "show_docstring_modules": True,
+    "extensions": [],
+    "search_paths": [],
 }
 ```
 
@@ -127,10 +130,12 @@ Attributes:
 
 - **`allow_inspection`** (`bool`) – Allow using introspection on modules for which sources aren't available (compiled modules, etc.).
 - **`annotations_path`** (`Literal['brief', 'source', 'full']`) – The verbosity for annotations path: brief (recommended), source (as written in the source), or full.
-- **`docstring_options`** (`dict`) – mkdocstring configuration
+- **`docstring_options`** (`DocstringOptions`) – mkdocstring configuration
 - **`docstring_section_style`** (`Literal['list', 'table']`) – The style used to render docstring sections.
 - **`docstring_style`** (`Literal['google', 'numpy', 'sphinx', 'auto'] | None`) – The style in which docstrings are written: auto, google, numpy, sphinx, or None.
+- **`extensions`** (`list[LoadableExtensionType]`) – A list of Griffe extensions to load.
 - **`filters`** (`list[str] | list[tuple[Pattern[str], bool]]`) – A list of filters.
+- **`force_inspection`** (`bool`) – Force using introspection on modules even if sources are available.
 - **`group_by_category`** (`bool`) – Group the object's children by categories: attributes, classes, functions, and modules.
 - **`heading_level`** (`int`) – The initial heading level to use.
 - **`inherited_members`** (`bool | list[str]`) – A boolean, or an explicit list of inherited members to render.
@@ -140,6 +145,7 @@ Attributes:
 - **`members_order`** (`Literal['alphabetical', 'source']`) – The members ordering to use.
 - **`merge_init_into_class`** (`bool`) – Whether to merge the __init__ method into the class' signature and docstring.
 - **`preload_modules`** (`list[str] | None`) – Pre-load modules that are not specified directly in autodoc instructions (::: identifier).
+- **`search_paths`** (`list[str]`) – A list of paths to search packages into.
 - **`separate_signature`** (`bool`) – Whether to put the whole signature in a code block below the heading.
 - **`show_bases`** (`bool`) – Show the base classes of a class.
 - **`show_category_heading`** (`bool`) – When grouped by categories, show a heading for each category.
@@ -186,7 +192,7 @@ The verbosity for annotations path: `brief` (recommended), `source` (as written
 ### docstring_options
 
 ```
-docstring_options: dict
+docstring_options: DocstringOptions
 ```
 
 mkdocstring [configuration](https://mkdocstrings.github.io/python/usage/configuration/general/)
@@ -209,6 +215,14 @@ docstring_style: (
 
 The style in which docstrings are written: `auto`, `google`, `numpy`, `sphinx`, or `None`.
 
+### extensions
+
+```
+extensions: list[LoadableExtensionType]
+```
+
+A list of Griffe extensions to load.
+
 ### filters
 
 ```
@@ -219,6 +233,14 @@ A list of filters.
 
 A filter starting with `!` will exclude matching objects instead of including them. The `members` option takes precedence over `filters` (filters will still be applied recursively to lower members in the hierarchy).
 
+### force_inspection
+
+```
+force_inspection: bool
+```
+
+Force using introspection on modules even if sources are available.
+
 ### group_by_category
 
 ```
@@ -304,6 +326,14 @@ For an imported member to be rendered, you need to add it to the `__all__` attri
 
 The modules must be listed as an array of strings.
 
+### search_paths
+
+```
+search_paths: list[str]
+```
+
+A list of paths to search packages into.
+
 ### separate_signature
 
 ```
@@ -1418,6 +1448,10 @@ Parameters:
 - **`obj`** (`Object`) – The Griffe object to render docs for.
 - **`config`** (`ConfigDict | None`, default: `None` ) – The rendering configuration.
 
+Warning
+
+When using this function programmatically, options such as `docstring_style` and `docstring_options` must be passed to the Griffe loader so that they are correctly set when loading data. Check griffe.GriffeLoader for more information.
+
 Returns:
 
 - `str` – Markdown.
@@ -1432,6 +1466,12 @@ def render_object_docs(obj: Object, config: ConfigDict | None = None) -> str:
         obj: The Griffe object to render docs for.
         config: The rendering configuration.
 
+    Warning:
+        When using this function programmatically,
+        options such as `docstring_style` and `docstring_options` must be passed
+        to the Griffe loader so that they are correctly set when loading data.
+        Check [`griffe.GriffeLoader`][] for more information.
+
     Returns:
         Markdown.
     """
@@ -1475,7 +1515,16 @@ def render_package_docs(package: str, config: ConfigDict | None = None) -> str:
     """
     config = cast("ConfigDict", {**default_config, **(config or {})})
     parser = config["docstring_style"] and Parser(config["docstring_style"])
-    loader = GriffeLoader(docstring_parser=parser)
+    parser_options: DocstringOptions = config["docstring_options"]
+    extensions = load_extensions(*config["extensions"]) if config["extensions"] else None
+    loader = GriffeLoader(
+        extensions=extensions,
+        search_paths=config["search_paths"] + sys.path,
+        docstring_parser=parser,
+        docstring_options=parser_options,
+        allow_inspection=config["allow_inspection"],
+        force_inspection=config["force_inspection"],
+    )
     module = loader.load(package)
     loader.resolve_aliases(external=True)
     return render_object_docs(module, config)  # type: ignore[arg-type]