Deployed e31887f with MkDocs version: 1.6.1

Author: pawamoy

changelog/index.html

@@ -48,3 +48,6 @@ goals:
     - name: "Filtering method: `public`"
       ref: /usage/configuration/members/#option-filters-public
       since: 2025/03/20
+    - name: "Ordering method: `__all__`"
+      ref: /usage/configuration/members/#option-members_order
+      since: 2025/03/24

credits/index.html

@@ -102,12 +102,16 @@ Attributes:
 ## Order
 
 ```python
-Order = Literal['alphabetical', 'source']
+Order = Literal['__all__', 'alphabetical', 'source']
 
 ```
 
 Ordering methods.
 
+- `__all__`: order members according to `__all__` module attributes, if declared;
+- `alphabetical`: order members alphabetically;
+- `source`: order members as they appear in the source file.
+
 ## Tree
 
 ```python
@@ -1333,7 +1337,7 @@ PythonInputOptions(
     inherited_members: bool | list[str] = False,
     line_length: int = 60,
     members: list[str] | bool | None = None,
-    members_order: Literal["alphabetical", "source"] = "alphabetical",
+    members_order: Order | list[Order] = "alphabetical",
     merge_init_into_class: bool = False,
     modernize_annotations: bool = False,
     parameter_headings: bool = False,
@@ -1406,7 +1410,7 @@ Attributes:
 - **`inherited_members`** (`bool | list[str]`) – A boolean, or an explicit list of inherited members to render.
 - **`line_length`** (`int`) – Maximum line length when formatting code/signatures.
 - **`members`** (`list[str] | bool | None`) – A boolean, or an explicit list of members to render.
-- **`members_order`** (`Literal['alphabetical', 'source']`) – The members ordering to use.
+- **`members_order`** (`Order | list[Order]`) – The members ordering to use.
 - **`merge_init_into_class`** (`bool`) – Whether to merge the __init__ method into the class' signature and docstring.
 - **`modernize_annotations`** (`bool`) – Whether to modernize annotations, for example Optional[str] into str | None.
 - **`parameter_headings`** (`bool`) – Whether to render headings for parameters (therefore showing parameters in the ToC).
@@ -1627,15 +1631,18 @@ If true, select all members without further filtering. If false or empty list, d
 ### members_order
 
 ```python
-members_order: Literal['alphabetical', 'source'] = 'alphabetical'
+members_order: Order | list[Order] = 'alphabetical'
 
 ```
 
 The members ordering to use.
 
-- `alphabetical`: order by the members names,
+- `__all__`: order members according to `__all__` module attributes, if declared;
+- `alphabetical`: order members alphabetically;
 - `source`: order members as they appear in the source file.
 
+Since `__all__` is a module-only attribute, it can't be used to sort class members, therefore the `members_order` option accepts a list of ordering methods, indicating ordering preferences.
+
 ### merge_init_into_class
 
 ```python
@@ -2061,7 +2068,7 @@ PythonOptions(
     inherited_members: bool | list[str] = False,
     line_length: int = 60,
     members: list[str] | bool | None = None,
-    members_order: Literal["alphabetical", "source"] = "alphabetical",
+    members_order: Order | list[Order] = "alphabetical",
     merge_init_into_class: bool = False,
     modernize_annotations: bool = False,
     parameter_headings: bool = False,
@@ -2149,7 +2156,7 @@ Attributes:
 - **`inherited_members`** (`bool | list[str]`) – A boolean, or an explicit list of inherited members to render.
 - **`line_length`** (`int`) – Maximum line length when formatting code/signatures.
 - **`members`** (`list[str] | bool | None`) – A boolean, or an explicit list of members to render.
-- **`members_order`** (`Literal['alphabetical', 'source']`) – The members ordering to use.
+- **`members_order`** (`Order | list[Order]`) – The members ordering to use.
 - **`merge_init_into_class`** (`bool`) – Whether to merge the __init__ method into the class' signature and docstring.
 - **`modernize_annotations`** (`bool`) – Whether to modernize annotations, for example Optional[str] into str | None.
 - **`parameter_headings`** (`bool`) – Whether to render headings for parameters (therefore showing parameters in the ToC).
@@ -2364,15 +2371,18 @@ If true, select all members without further filtering. If false or empty list, d
 ### members_order
 
 ```python
-members_order: Literal['alphabetical', 'source'] = 'alphabetical'
+members_order: Order | list[Order] = 'alphabetical'
 
 ```
 
 The members ordering to use.
 
-- `alphabetical`: order by the members names,
+- `__all__`: order members according to `__all__` module attributes, if declared;
+- `alphabetical`: order members alphabetically;
 - `source`: order members as they appear in the source file.
 
+Since `__all__` is a module-only attribute, it can't be used to sort class members, therefore the `members_order` option accepts a list of ordering methods, indicating ordering preferences.
+
 ### merge_init_into_class
 
 ```python
@@ -3183,7 +3193,7 @@ Returns:
 ```python
 do_order_members(
     members: Sequence[Object | Alias],
-    order: Order,
+    order: Order | list[Order],
     members_list: bool | list[str] | None,
 ) -> Sequence[Object | Alias]
 
@@ -3199,7 +3209,7 @@ Parameters:
 
 - ### **`order`**
 
-  (`Order`) – The ordering method.
+  (`Order | list[Order]`) – The ordering method.
 
 - ### **`members_list`**
 

insiders/changelog/index.html

@@ -469,15 +469,31 @@
           "title": "members"
         },
         "members_order": {
-          "default": "alphabetical",
-          "description": "The members ordering to use.\n\n- `alphabetical`: order by the members names,\n- `source`: order members as they appear in the source file.",
-          "enum": [
-            "alphabetical",
-            "source"
+          "anyOf": [
+            {
+              "enum": [
+                "__all__",
+                "alphabetical",
+                "source"
+              ],
+              "type": "string"
+            },
+            {
+              "items": {
+                "enum": [
+                  "__all__",
+                  "alphabetical",
+                  "source"
+                ],
+                "type": "string"
+              },
+              "type": "array"
+            }
           ],
-          "markdownDescription": "[DOCUMENTATION](https://mkdocstrings.github.io/python/usage/configuration/members/#members_order)\n\nThe members ordering to use.\n\n- `alphabetical`: order by the members names,\n- `source`: order members as they appear in the source file.",
-          "title": "members_order",
-          "type": "string"
+          "default": "alphabetical",
+          "description": "The members ordering to use.\n\n- `__all__`: order members according to `__all__` module attributes, if declared;\n- `alphabetical`: order members alphabetically;\n- `source`: order members as they appear in the source file.\n\nSince `__all__` is a module-only attribute, it can't be used to sort class members,\ntherefore the `members_order` option accepts a list of ordering methods,\nindicating ordering preferences.",
+          "markdownDescription": "[DOCUMENTATION](https://mkdocstrings.github.io/python/usage/configuration/members/#members_order)\n\nThe members ordering to use.\n\n- `__all__`: order members according to `__all__` module attributes, if declared;\n- `alphabetical`: order members alphabetically;\n- `source`: order members as they appear in the source file.\n\nSince `__all__` is a module-only attribute, it can't be used to sort class members,\ntherefore the `members_order` option accepts a list of ordering methods,\nindicating ordering preferences.",
+          "title": "members_order"
         },
         "merge_init_into_class": {
           "default": false,

insiders/goals.yml

@@ -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-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/changelog/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/code_of_conduct/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/contributing/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/credits/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/license/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/insiders/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/insiders/changelog/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/insiders/installation/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/reference/api/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/customization/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/extensions/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/docstrings/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/general/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/headings/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/members/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/configuration/signatures/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/docstrings/google/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/docstrings/numpy/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
     <url>
          <loc>https://mkdocstrings.github.io/python/usage/docstrings/sphinx/</loc>
-         <lastmod>2025-03-20</lastmod>
+         <lastmod>2025-03-24</lastmod>
     </url>
 </urlset>