Move skip_local_inventory to general options

mkdocstrings · bswck · Jul 13, 2025 · Jul 13, 2025 · Jul 13, 2025 · Jul 13, 2025
commit 3c4e610ee04e2c81fc0d46a84e6508f9e18522c6
diff --git a/docs/usage/configuration/general.md b/docs/usage/configuration/general.md
@@ -494,3 +494,63 @@ def some_function():
 <p>Docstring of the function.</p>
 ////
 ///
+
+[](){#option-skip_local_inventory}
+## `skip_local_inventory`
+
+- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
+<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
+
+Whether to not give objects local inventory entries.
+
+With this option enabled, re-rendering docstrings for objects from external inventories is possible with their cross-references pointing to the original external inventory, not local.
+
+```yaml title="in mkdocs.yml (global configuration)"
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          skip_local_inventory: false
+```
+
+```md title="or in docs/some_page.md (local configuration)"
+::: path.to.module
+    options:
+      skip_local_inventory: true
+```
+
+/// admonition | Preview
+    type: preview
+
+
+//// tab | Without `skip_local_inventory`
+
+```md exec="on"
+::: bisect.bisect_left
+    options:
+      heading_level: 3
+      skip_local_inventory: false
+      show_docstring_description: false
+```
+
+Notice how [`bisect.bisect_left`][] now points to the section above.
+
+////
+
+//// tab | With `skip_local_inventory`
+
+```md exec="on"
+::: bisect.bisect_right
+    inventories:
+    - https://docs.python.org/3/objects.inv
+    options:
+      heading_level: 3
+      skip_local_inventory: true
+      show_docstring_description: false
+```
+
+Notice how [`bisect.bisect_right`][] points to the original Python documentation.
+
+////
+///
diff --git a/docs/usage/configuration/headings.md b/docs/usage/configuration/headings.md
@@ -664,68 +664,6 @@ plugins:
 ////
 ///
 
-
-[](){#option-skip_local_inventory}
-## `skip_local_inventory`
-
-- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
-<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
-
-Whether to not give objects local inventory entries.
-
-With this option enabled, re-rendering docstrings for objects from external inventories is possible with their cross-references pointing to the original external inventory, not local.
-
-```yaml title="in mkdocs.yml (global configuration)"
-plugins:
-- mkdocstrings:
-    handlers:
-      python:
-        options:
-          skip_local_inventory: false
-```
-
-```md title="or in docs/some_page.md (local configuration)"
-::: path.to.module
-    options:
-      skip_local_inventory: true
-```
-
-/// admonition | Preview
-    type: preview
-
-
-//// tab | Without `skip_local_inventory`
-
-```md exec="on"
-::: bisect.bisect_left
-    options:
-      heading_level: 3
-      skip_local_inventory: false
-      show_docstring_description: false
-```
-
-Notice how [`bisect.bisect_left`][] now points to the section above.
-
-////
-
-//// tab | With `skip_local_inventory`
-
-```md exec="on"
-::: bisect.bisect_right
-    inventories:
-    - https://docs.python.org/3/objects.inv
-    options:
-      heading_level: 3
-      skip_local_inventory: true
-      show_docstring_description: false
-```
-
-Notice how [`bisect.bisect_right`][] points to the original Python documentation.
-
-////
-
-///
-
 [](){#option-toc_label}
 ## `toc_label`
 

diff --git a/src/mkdocstrings_handlers/python/_internal/config.py b/src/mkdocstrings_handlers/python/_internal/config.py
@@ -868,7 +868,7 @@ class PythonInputOptions:
     skip_local_inventory: Annotated[
         bool,
         _Field(
-            group="headings",
+            group="general",
             description="Whether to not give objects local inventory entries.",
         ),
     ] = False