list [str | dict [str , dict [str , Any ]]]your_funcFunction docstring
+//// + +//// tab | Without find_stubs_package +your_funclist [str ] | Noneyour_moduleDocstring of your module.
+their_objectDocstring of their object.
+//// + +//// tab | Without preloaded modules +your_moduleDocstring of your module.
+//// +/// + +[](){#option-show_bases} ## `show_bases` - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** @@ -92,6 +321,7 @@ plugins: //// /// +[](){#option-show_inheritance_diagram} ## `show_inheritance_diagram` [:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } — @@ -177,6 +407,7 @@ Mixin2A --> Mixin2B because these classes do not exist in our documentation.* /// +[](){#option-show_source} ## `show_source` - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }** @@ -221,115 +452,3 @@ def some_function():Docstring of the function.
//// /// - -## `preload_modules` - -- **:octicons-package-24: Typelist [str ] | Noneyour_moduleDocstring of your module.
-their_objectDocstring of their object.
-//// - -//// tab | Without preloaded modules -your_moduleDocstring of your module.
-//// -/// - -## `find_stubs_package` - -- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }** - - -When looking for documentation specified in [autodoc instructions][autodoc syntax] (`::: identifier`), also look for -the stubs package as defined in [PEP 561](https://peps.python.org/pep-0561/) if it exists. This is useful when -most of your documentation is separately provided by such a package and not inline in your main package. - -```yaml title="in mkdocs.yml (global configuration)" -plugins: -- mkdocstrings: - handlers: - python: - options: - find_stubs_package: true -``` - -```md title="or in docs/some_page.md (local configuration)" -::: your_package.your_module.your_func - options: - find_stubs_package: true -``` - -```python title="your_package/your_module.py" - -def your_func(a, b): - # Function code - ... - -# rest of your code -``` - -```python title="your_package-stubs/your_module.pyi" - -def your_func(a: int, b: str): - """ -your_funcFunction docstring
-//// - -//// tab | Without find_stubs_package -your_funclist [str ] |
@@ -95,6 +96,7 @@ this_attribute = 0
INFO: **The default behavior (with unspecified `members` or `members: null`) is to use [`filters`][].**
+[](){#option-inherited_members}
## `inherited_members`
- **:octicons-package-24: Type list [str ] |
@@ -259,6 +261,7 @@ class Main(Base):
///
+[](){#option-members_order}
## `members_order`
- **:octicons-package-24: Type [`str`][] :material-equal: `"alphabetical"`{ title="default value" }**
@@ -329,6 +332,7 @@ def function_c():
////
///
+[](){#option-filters}
## `filters`
- **:octicons-package-24: Type list [str ] | None{{ module_name }}
{% endif %}
@@ -56,7 +56,7 @@ Context:
{% block labels scoped %}
{#- Labels block.
-
+
This block renders the labels for the module.
-#}
{% with labels = module.labels %}
@@ -71,7 +71,7 @@ Context:
{% filter heading(heading_level,
role="module",
id=html_id,
- toc_label=('