Deployed d1f4067 with MkDocs version: 1.6.1

Author: pawamoy

changelog/index.html

@@ -45,3 +45,6 @@ goals:
     - name: Backlinks
       ref: /usage/configuration/general/#backlinks
       since: 2025/03/10
+    - name: "Filtering method: `public`"
+      ref: /usage/configuration/members/#option-filters-public
+      since: 2025/03/20

insiders/changelog/index.html

@@ -1325,7 +1325,7 @@ PythonInputOptions(
     docstring_section_style: Literal["table", "list", "spacy"] = "table",
     docstring_style: Literal["auto", "google", "numpy", "sphinx"] | None = "google",
     extensions: list[str | dict[str, Any]] = list(),
-    filters: list[str] = lambda: copy()(),
+    filters: list[str] | Literal["public"] = lambda: copy()(),
     find_stubs_package: bool = False,
     group_by_category: bool = True,
     heading: str = "",
@@ -1397,7 +1397,7 @@ Attributes:
 - **`docstring_style`** (`Literal['auto', 'google', 'numpy', 'sphinx'] | None`) – The docstring style to use: auto, google, numpy, sphinx, or None.
 - **`extensions`** (`list[str | dict[str, Any]]`) – A list of Griffe extensions to load.
 - **`extra`** (`dict[str, Any]`) – Extra options.
-- **`filters`** (`list[str]`) – A list of filters applied to filter objects based on their name.
+- **`filters`** (`list[str] | Literal['public']`) – A list of filters, or "public".
 - **`find_stubs_package`** (`bool`) – Whether to load stubs package (package-stubs) when extracting docstrings.
 - **`force_inspection`** (`bool`) – Whether to force using dynamic analysis when loading data.
 - **`group_by_category`** (`bool`) – Group the object's children by categories: attributes, classes, functions, and modules.
@@ -1532,14 +1532,22 @@ Extra options.
 ### filters
 
 ```python
-filters: list[str] = field(default_factory=lambda: copy())
+filters: list[str] | Literal['public'] = field(default_factory=lambda: copy())
 
 ```
 
-A list of filters applied to filter objects based on their name.
+A list of filters, or `"public"`.
+
+**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).
 
+**Filtering methods**
+
+[Sponsors only](../../insiders/) — [Insiders 1.11.0](../../insiders/changelog/#1.11.0)
+
+The `public` method will include only public objects: those added to `__all__` or not starting with an underscore (except for special methods/attributes).
+
 ### find_stubs_package
 
 ```python
@@ -2043,7 +2051,7 @@ PythonOptions(
     docstring_section_style: Literal["table", "list", "spacy"] = "table",
     docstring_style: Literal["auto", "google", "numpy", "sphinx"] | None = "google",
     extensions: list[str | dict[str, Any]] = list(),
-    filters: list[tuple[Pattern, bool]] = lambda: [
+    filters: list[tuple[Pattern, bool]] | Literal["public"] = lambda: [
         (compile(removeprefix("!")), startswith("!")) for filtr in _DEFAULT_FILTERS
     ](),
     find_stubs_package: bool = False,
@@ -2132,7 +2140,7 @@ Attributes:
 - **`docstring_style`** (`Literal['auto', 'google', 'numpy', 'sphinx'] | None`) – The docstring style to use: auto, google, numpy, sphinx, or None.
 - **`extensions`** (`list[str | dict[str, Any]]`) – A list of Griffe extensions to load.
 - **`extra`** (`dict[str, Any]`) – Extra options.
-- **`filters`** (`list[tuple[Pattern, bool]]`) – A list of filters applied to filter objects based on their name.
+- **`filters`** (`list[tuple[Pattern, bool]] | Literal['public']`) – A list of filters, or "public".
 - **`find_stubs_package`** (`bool`) – Whether to load stubs package (package-stubs) when extracting docstrings.
 - **`force_inspection`** (`bool`) – Whether to force using dynamic analysis when loading data.
 - **`group_by_category`** (`bool`) – Group the object's children by categories: attributes, classes, functions, and modules.
@@ -2267,15 +2275,15 @@ Extra options.
 ### filters
 
 ```python
-filters: list[tuple[Pattern, bool]] = field(
+filters: list[tuple[Pattern, bool]] | Literal["public"] = field(
     default_factory=lambda: [
         (compile(removeprefix("!")), startswith("!")) for filtr in _DEFAULT_FILTERS
     ]
 )
 
 ```
 
-A list of filters applied to filter objects based on their name.
+A list of filters, or `"public"`.
 
 ### find_stubs_package
 
@@ -2976,7 +2984,7 @@ Returns:
 do_filter_objects(
     objects_dictionary: dict[str, Object | Alias],
     *,
-    filters: Sequence[tuple[Pattern, bool]] | None = None,
+    filters: Sequence[tuple[Pattern, bool]] | Literal["public"] | None = None,
     members_list: bool | list[str] | None = None,
     inherited_members: bool | list[str] = False,
     keep_no_docstrings: bool = True
@@ -2994,7 +3002,7 @@ Parameters:
 
 - ### **`filters`**
 
-  (`Sequence[tuple[Pattern, bool]] | None`, default: `None` ) – Filters to apply, based on members' names. Each element is a tuple: a pattern, and a boolean indicating whether to reject the object if the pattern matches.
+  (`Sequence[tuple[Pattern, bool]] | Literal['public'] | None`, default: `None` ) – Filters to apply, based on members' names, or "public". Each element is a tuple: a pattern, and a boolean indicating whether to reject the object if the pattern matches.
 
 - ### **`members_list`**
 

insiders/goals.yml

@@ -380,13 +380,21 @@
           "type": "array"
         },
         "filters": {
-          "description": "A list of filters applied to filter objects based on their name.\n\nA filter starting with `!` will exclude matching objects instead of including them.\nThe `members` option takes precedence over `filters` (filters will still be applied recursively\nto lower members in the hierarchy).",
-          "items": {
-            "type": "string"
-          },
-          "markdownDescription": "[DOCUMENTATION](https://mkdocstrings.github.io/python/usage/configuration/members/#filters)\n\nA list of filters applied to filter objects based on their name.\n\nA filter starting with `!` will exclude matching objects instead of including them.\nThe `members` option takes precedence over `filters` (filters will still be applied recursively\nto lower members in the hierarchy).",
-          "title": "filters",
-          "type": "array"
+          "anyOf": [
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            },
+            {
+              "const": "public",
+              "type": "string"
+            }
+          ],
+          "description": "A list of filters, or `\"public\"`.\n\n**List of filters**\n\nA filter starting with `!` will exclude matching objects instead of including them.\nThe `members` option takes precedence over `filters` (filters will still be applied recursively\nto lower members in the hierarchy).\n\n**Filtering methods**\n\n[:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders } —\n[:octicons-tag-24: Insiders 1.11.0](../insiders/changelog.md#1.11.0)\n\nThe `public` method will include only public objects:\nthose added to `__all__` or not starting with an underscore (except for special methods/attributes).",
+          "markdownDescription": "[DOCUMENTATION](https://mkdocstrings.github.io/python/usage/configuration/members/#filters)\n\nA list of filters, or `\"public\"`.\n\n**List of filters**\n\nA filter starting with `!` will exclude matching objects instead of including them.\nThe `members` option takes precedence over `filters` (filters will still be applied recursively\nto lower members in the hierarchy).\n\n**Filtering methods**\n\n[:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders } —\n[:octicons-tag-24: Insiders 1.11.0](../insiders/changelog.md#1.11.0)\n\nThe `public` method will include only public objects:\nthose added to `__all__` or not starting with an underscore (except for special methods/attributes).",
+          "title": "filters"
         },
         "find_stubs_package": {
           "default": false,

insiders/index.html

@@ -2,86 +2,86 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://mkdocstrings.github.io/python/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/changelog/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/code_of_conduct/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/contributing/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/credits/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/license/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/insiders/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/insiders/changelog/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/insiders/installation/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/reference/api/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/customization/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/extensions/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/docstrings/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/general/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/headings/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/members/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/signatures/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/docstrings/google/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/docstrings/numpy/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/docstrings/sphinx/</loc>
-         <lastmod>2025-03-18</lastmod>
+         <lastmod>2025-03-20</lastmod>
     </url>
 </urlset>