Merge branch 'main' into bartosz/skip-local-inventory

Author: pawamoy

docs/usage/configuration/members.md

@@ -519,50 +519,6 @@ def function_d():
 ////
 ///
 
-
-[](){#option-show_attribute_values}
-## `show_attribute_values`
-
-- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
-<!-- - **:octicons-project-template-24: Template :material-null:** (contained in [`class.html`][class template]) -->
-
-Show initial values of attributes in classes.
-
-```yaml title="in mkdocs.yml (global configuration)"
-plugins:
-- mkdocstrings:
-    handlers:
-      python:
-        options:
-          show_attribute_values: true
-```
-
-```md title="or in docs/some_page.md (local configuration)"
-::: path.to.object
-    options:
-      show_attribute_values: true
-```
-
-```python title="package/module.py"
-class SomeClass:
-  def __init__(self):
-      self.some_attr = 1
-```
-
-/// admonition | Preview
-    type: preview
-
-//// tab | With attribute values visible
-<h2><code>SomeClass</code></h2>
-<p>some_attr = 1</p>
-////
-
-//// tab | With attribute values hidden
-<h2><code>SomeClass</code></h2>
-<p>some_attr</p>
-////
-///
-
 [](){#option-show_submodules}
 ## `show_submodules`
 

docs/usage/configuration/signatures.md

@@ -483,6 +483,49 @@ function(param1, param2=None)
 ////
 ///
 
+[](){#option-show_attribute_values}
+## `show_attribute_values`
+
+- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
+<!-- - **:octicons-project-template-24: Template :material-null:** (contained in [`class.html`][class template]) -->
+
+Show initial values of attributes in classes.
+
+```yaml title="in mkdocs.yml (global configuration)"
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          show_attribute_values: true
+```
+
+```md title="or in docs/some_page.md (local configuration)"
+::: path.to.object
+    options:
+      show_attribute_values: true
+```
+
+```python title="package/module.py"
+class SomeClass:
+  def __init__(self):
+      self.some_attr = 1
+```
+
+/// admonition | Preview
+    type: preview
+
+//// tab | With attribute values visible
+<h2><code>SomeClass</code></h2>
+<p>some_attr = 1</p>
+////
+
+//// tab | With attribute values hidden
+<h2><code>SomeClass</code></h2>
+<p>some_attr</p>
+////
+///
+
 [](){#option-show_overloads}
 ## `show_overloads`
 

docs/usage/index.md

@@ -150,9 +150,11 @@ plugins:
   [__all__]: https://docs.python.org/3/tutorial/modules.html#importing-from-a-package
 
 [](){#setting-locale}
-#### `locale`
+#### ~~`locale`~~
 
-The locale to use when translating template strings. The translation system is not fully ready yet, so we don't recommend setting the option for now.
+**Deprecated.** Use mkdocstrings' own `locale` setting.
+
+~~The locale to use when translating template strings.~~
 
 [](){#setting-paths}
 #### `paths`

src/mkdocstrings_handlers/python/_internal/config.py

@@ -625,7 +625,7 @@ class PythonInputOptions:
     show_attribute_values: Annotated[
         bool,
         _Field(
-            group="members",
+            group="signatures",
             description="Show initial values of attributes in classes.",
         ),
     ] = True
@@ -1043,7 +1043,9 @@ class PythonInputConfig:
 
     locale: Annotated[
         str | None,
-        _Field(description="The locale to use when translating template strings."),
+        _Field(
+            description="Deprecated. Use mkdocstrings' own `locale` setting instead. The locale to use when translating template strings.",
+        ),
     ] = None
 
     @classmethod

src/mkdocstrings_handlers/python/_internal/handler.py

@@ -278,12 +278,13 @@ def collect(self, identifier: str, options: PythonOptions) -> CollectorItem:
 
         return doc_object
 
-    def render(self, data: CollectorItem, options: PythonOptions) -> str:
+    def render(self, data: CollectorItem, options: PythonOptions, locale: str | None = None) -> str:
         """Render the collected data.
 
         Parameters:
             data: The collected data.
             options: The options to use for rendering.
+            locale: The locale to use for rendering (default is "en").
 
         Returns:
             The rendered data (HTML).
@@ -300,7 +301,8 @@ def render(self, data: CollectorItem, options: PythonOptions) -> str:
                 # than as an item in a dictionary.
                 "heading_level": options.heading_level,
                 "root": True,
-                "locale": self.config.locale,
+                # YORE: Bump 2: Regex-replace ` or .+` with ` or "en",` within line.
+                "locale": locale or self.config.locale,
             },
         )
 
@@ -401,6 +403,7 @@ def get_handler(
     Parameters:
         handler_config: The handler configuration.
         tool_config: The tool (SSG) configuration.
+        **kwargs: Additional arguments to pass to the handler.
 
     Returns:
         An instance of `PythonHandler`.