mkdocstrings-python 1.16.6__tar.gz → 1.16.8__tar.gz

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/CHANGELOG.md

@@ -5,6 +5,27 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.16.8](https://github.com/mkdocstrings/python/releases/tag/1.16.8) - 2025-03-24
+
+<small>[Compare with 1.16.7](https://github.com/mkdocstrings/python/compare/1.16.7...1.16.8)</small>
+
+### Bug Fixes
+
+- Prevent infinite recursion by detecting parent-member cycles ([f3917e9](https://github.com/mkdocstrings/python/commit/f3917e9dd50ca7f94d0dd22b6e4e11885b4617e7) by Timothée Mazzucotelli). [Issue-griffe-368](https://github.com/mkdocstrings/griffe/issues/368)
+
+### Code Refactoring
+
+- Prepare feature for ordering by `__all__` value ([bfb5b30](https://github.com/mkdocstrings/python/commit/bfb5b303f4ea2187c15bccc688f7eba25e7edfcc) by Timothée Mazzucotelli). [Issue-219](https://github.com/mkdocstrings/python/issues/219)
+- Sort objects without line numbers last instead of first ([681afb1](https://github.com/mkdocstrings/python/commit/681afb146225d98350a8eb2178aab07aec95fe6b) by Timothée Mazzucotelli).
+
+## [1.16.7](https://github.com/mkdocstrings/python/releases/tag/1.16.7) - 2025-03-20
+
+<small>[Compare with 1.16.6](https://github.com/mkdocstrings/python/compare/1.16.6...1.16.7)</small>
+
+### Code Refactoring
+
+- Prepare `public` filtering method feature ([fde2019](https://github.com/mkdocstrings/python/commit/fde20191cab20f39d9e5e729a95cdfa3390b8f1f) by Timothée Mazzucotelli). [Issue-78](https://github.com/mkdocstrings/python/issues/78)
+
 ## [1.16.6](https://github.com/mkdocstrings/python/releases/tag/1.16.6) - 2025-03-18
 
 <small>[Compare with 1.16.5](https://github.com/mkdocstrings/python/compare/1.16.5...1.16.6)</small>

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 1.16.6
+Version: 1.16.8
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License-Expression: ISC
@@ -32,7 +32,7 @@ Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.9
 Requires-Dist: mkdocstrings>=0.28.3
 Requires-Dist: mkdocs-autorefs>=1.4
-Requires-Dist: griffe>=0.49
+Requires-Dist: griffe>=1.6.2
 Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
 Description-Content-Type: text/markdown
 

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/docs/insiders/changelog.md

@@ -2,6 +2,14 @@
 
 ## mkdocstrings-python Insiders
 
+### 1.12.0 <small>March 22, 2025</small> { id="1.12.0" }
+
+- [Ordering method: `__all__`][option-members_order]
+
+### 1.11.0 <small>March 20, 2025</small> { id="1.11.0" }
+
+- [Filtering method: `public`][option-filters-public]
+
 ### 1.10.0 <small>March 10, 2025</small> { id="1.10.0" }
 
 - [Backlinks][backlinks]

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/docs/insiders/goals.yml

@@ -45,3 +45,9 @@ 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
+    - name: "Ordering method: `__all__`"
+      ref: /usage/configuration/members/#option-members_order
+      since: 2025/03/22

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/docs/usage/configuration/members.md

@@ -264,13 +264,14 @@ class Main(Base):
 [](){#option-members_order}
 ## `members_order`
 
-- **:octicons-package-24: Type [`str`][] :material-equal: `"alphabetical"`{ title="default value" }**
+- **:octicons-package-24: Type `str | list[str]` :material-equal: `"alphabetical"`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
 The members ordering to use. Possible values:
 
-- `alphabetical`: order by the members names.
-- `source`: order members as they appear in the source file.
+- `__all__` ([:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash; [:octicons-tag-24: Insiders 1.12.0](../../insiders/changelog.md#1.12.0)): Order according to `__all__` attributes. Since classes do not define `__all__` attributes, you can specify a second ordering method by using a list.
+- `alphabetical`: Order by the members names.
+- `source`: Order members as they appear in the source file.
 
 The order applies for all members, recursively.
 The order will be ignored for members that are explicitely sorted using the [`members`][] option.
@@ -292,6 +293,12 @@ plugins:
       members_order: source
 ```
 
+```md title="or in docs/some_page.md (local configuration)"
+::: package.module
+    options:
+      members_order: [__all__, source]
+```
+
 ```python title="package/module.py"
 """Module docstring."""
 
@@ -335,10 +342,21 @@ def function_c():
 [](){#option-filters}
 ## `filters`
 
-- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] | None</code>  :material-equal: `["!^_[^_]"]`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] | <autoref identifier="typing.Literal" optional>Literal</autoref>["public"] | None</code>  :material-equal: `["!^_[^_]"]`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
-A list of filters applied to filter objects based on their name.
+A list of filters, or `"public"`.
+
+**Filtering methods**
+
+[](){#option-filters-public}
+
+[:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash;
+[:octicons-tag-24: Insiders 1.11.0](../../insiders/changelog.md#1.11.0)
+
+The `public` filtering method will include only public objects: those added to the `__all__` attribute of modules, or not starting with a single underscore. Special methods and attributes ("dunder" methods/attributes, starting and ending with two underscores), like `__init__`, `__call__`, `__mult__`, etc., are always considered public.
+
+**List of filters**
 
 Filters are regular expressions. These regular expressions are evaluated by Python
 and so must match the syntax supported by the [`re`][] module.
@@ -379,13 +397,13 @@ plugins:
       python:
         options:
           filters:
-          - "!^_"
+          - "!^_[^_]"
 ```
 
 ```md title="or in docs/some_page.md (local configuration)"
 ::: package.module
     options:
-      filters: []
+      filters: public
 ```
 
 ```python title="package/module.py"

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/docs/usage/index.md

@@ -87,8 +87,8 @@ plugins:
 - mkdocstrings:
     handlers:
       python:
-        import:
-        - https://docs.python-requests.org/en/master/objects.inv
+        inventories:
+        - https://docs.python.org/3/objects.inv
 ```
 
 When loading an inventory, you enable automatic cross-references

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/mkdocs.yml

@@ -160,7 +160,7 @@ plugins:
             ignore_init_summary: true
           docstring_section_style: list
           extensions: [scripts/griffe_extensions.py]
-          filters: ["!^_"]
+          filters: public
           heading_level: 1
           inherited_members: true
           line_length: 88

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/pyproject.toml

@@ -39,10 +39,10 @@ classifiers = [
 dependencies = [
     "mkdocstrings>=0.28.3",
     "mkdocs-autorefs>=1.4",
-    "griffe>=0.49",
+    "griffe>=1.6.2",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "1.16.6"
+version = "1.16.8"
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/python"

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/src/mkdocstrings_handlers/python/_internal/config.py

@@ -9,6 +9,8 @@ from typing import TYPE_CHECKING, Annotated, Any, Literal
 
 from mkdocstrings import get_logger
 
+from mkdocstrings_handlers.python._internal.rendering import Order  # noqa: TC001
+
 # YORE: EOL 3.10: Replace block with line 2.
 if sys.version_info >= (3, 11):
     from typing import Self
@@ -432,14 +434,24 @@ class PythonInputOptions:
     ] = field(default_factory=list)
 
     filters: Annotated[
-        list[str],
+        list[str] | Literal["public"],
         _Field(
             group="members",
-            description="""A list of filters applied to filter objects based on their name.
+            description="""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**
+
+            [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders } —
+            [:octicons-tag-24: Insiders 1.11.0](../insiders/changelog.md#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).
             """,
         ),
     ] = field(default_factory=lambda: _DEFAULT_FILTERS.copy())
@@ -510,13 +522,18 @@ class PythonInputOptions:
     ] = None
 
     members_order: Annotated[
-        Literal["alphabetical", "source"],
+        Order | list[Order],
         _Field(
             group="members",
             description="""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.
             """,
         ),
     ] = "alphabetical"
@@ -916,12 +933,12 @@ class PythonInputOptions:
 class PythonOptions(PythonInputOptions):  # type: ignore[override,unused-ignore]
     """Final options passed as template context."""
 
-    filters: list[tuple[re.Pattern, bool]] = field(  # type: ignore[assignment]
+    filters: list[tuple[re.Pattern, bool]] | Literal["public"] = field(  # type: ignore[assignment]
         default_factory=lambda: [
             (re.compile(filtr.removeprefix("!")), filtr.startswith("!")) for filtr in _DEFAULT_FILTERS
         ],
     )
-    """A list of filters applied to filter objects based on their name."""
+    """A list of filters, or `"public"`."""
 
     summary: SummaryOption = field(default_factory=SummaryOption)
     """Whether to render summaries of modules, classes, functions (methods) and attributes."""
@@ -930,6 +947,11 @@ class PythonOptions(PythonInputOptions):  # type: ignore[override,unused-ignore]
     def coerce(cls, **data: Any) -> MutableMapping[str, Any]:
         """Create an instance from a dictionary."""
         if "filters" in data:
+            # Non-insiders: transform back to default filters.
+            # Next: `if "filters" in data and not isinstance(data["filters"], str):`.
+            if data["filters"] == "public":
+                data["filters"] = _DEFAULT_FILTERS
+            # Filters are `None` or a sequence of strings (tests use tuples).
             data["filters"] = [
                 (re.compile(filtr.removeprefix("!")), filtr.startswith("!")) for filtr in data["filters"] or ()
             ]

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/src/mkdocstrings_handlers/python/_internal/rendering.py

@@ -9,6 +9,7 @@ import subprocess
 import sys
 import warnings
 from collections import defaultdict
+from contextlib import suppress
 from dataclasses import replace
 from functools import lru_cache
 from pathlib import Path
@@ -17,6 +18,8 @@ from typing import TYPE_CHECKING, Any, Callable, ClassVar, Literal, TypeVar
 
 from griffe import (
     Alias,
+    AliasResolutionError,
+    CyclicAliasError,
     DocstringAttribute,
     DocstringClass,
     DocstringFunction,
@@ -43,26 +46,35 @@ if TYPE_CHECKING:
 _logger = get_logger(__name__)
 
 
-def _sort_key_alphabetical(item: CollectorItem) -> Any:
-    # chr(sys.maxunicode) is a string that contains the final unicode
-    # character, so if 'name' isn't found on the object, the item will go to
-    # the end of the list.
+def _sort_key_alphabetical(item: CollectorItem) -> str:
+    # `chr(sys.maxunicode)` is a string that contains the final unicode character,
+    # so if `name` isn't found on the object, the item will go to the end of the list.
     return item.name or chr(sys.maxunicode)
 
 
-def _sort_key_source(item: CollectorItem) -> Any:
-    # if 'lineno' is none, the item will go to the start of the list.
+def _sort_key_source(item: CollectorItem) -> float:
+    # If `lineno` is none, the item will go to the end of the list.
     if item.is_alias:
-        return item.alias_lineno if item.alias_lineno is not None else -1
-    return item.lineno if item.lineno is not None else -1
+        return item.alias_lineno if item.alias_lineno is not None else float("inf")
+    return item.lineno if item.lineno is not None else float("inf")
 
 
-Order = Literal["alphabetical", "source"]
-"""Ordering methods."""
+def _sort__all__(item: CollectorItem) -> float:  # noqa: ARG001
+    raise ValueError("Not implemented in public version of mkdocstrings-python")
 
-_order_map = {
+
+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.
+"""
+
+_order_map: dict[str, Callable[[Object | Alias], str | float]] = {
     "alphabetical": _sort_key_alphabetical,
     "source": _sort_key_source,
+    "__all__": _sort__all__,
 }
 
 
@@ -148,7 +160,7 @@ def do_format_signature(
         The same code, formatted.
     """
     env = context.environment
-    # YORE: Bump 2: Replace `do_get_template(env, "signature")` with `"signature.html.jinja"`.
+    # YORE: Bump 2: Replace `do_get_template(env, "signature")` with `"signature.html.jinja"` within line.
     template = env.get_template(do_get_template(env, "signature"))
 
     if annotations is None:
@@ -208,7 +220,7 @@ def do_format_attribute(
         The same code, formatted.
     """
     env = context.environment
-    # YORE: Bump 2: Replace `do_get_template(env, "expression")` with `"expression.html.jinja"`.
+    # YORE: Bump 2: Replace `do_get_template(env, "expression")` with `"expression.html.jinja"` within line.
     template = env.get_template(do_get_template(env, "expression"))
     annotations = context.parent["config"].show_signature_annotations
 
@@ -246,7 +258,7 @@ def do_format_attribute(
 
 def do_order_members(
     members: Sequence[Object | Alias],
-    order: Order,
+    order: Order | list[Order],
     members_list: bool | list[str] | None,
 ) -> Sequence[Object | Alias]:
     """Order members given an ordering method.
@@ -266,7 +278,12 @@ def do_order_members(
             if name in members_dict:
                 sorted_members.append(members_dict[name])
         return sorted_members
-    return sorted(members, key=_order_map[order])
+    if isinstance(order, str):
+        order = [order]
+    for method in order:
+        with suppress(ValueError):
+            return sorted(members, key=_order_map[method])
+    return members
 
 
 # YORE: Bump 2: Remove block.
@@ -396,10 +413,33 @@ def _keep_object(name: str, filters: Sequence[tuple[Pattern, bool]]) -> bool:
     return keep
 
 
+def _parents(obj: Alias) -> set[str]:
+    parent: Object | Alias = obj.parent  # type: ignore[assignment]
+    parents = {obj.path, parent.path}
+    if parent.is_alias:
+        parents.add(parent.final_target.path)  # type: ignore[union-attr]
+    while parent.parent:
+        parent = parent.parent
+        parents.add(parent.path)
+        if parent.is_alias:
+            parents.add(parent.final_target.path)  # type: ignore[union-attr]
+    return parents
+
+
+def _remove_cycles(objects: list[Object | Alias]) -> Iterator[Object | Alias]:
+    suppress_errors = suppress(AliasResolutionError, CyclicAliasError)
+    for obj in objects:
+        if obj.is_alias:
+            with suppress_errors:
+                if obj.final_target.path in _parents(obj):  # type: ignore[arg-type,union-attr]
+                    continue
+        yield obj
+
+
 def 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,
@@ -408,7 +448,7 @@ def do_filter_objects(
 
     Parameters:
         objects_dictionary: The dictionary of objects.
-        filters: Filters to apply, based on members' names.
+        filters: 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: An optional, explicit list of members to keep.
@@ -449,14 +489,20 @@ def do_filter_objects(
         ]
 
     # Use filters and docstrings.
-    if filters:
+    if filters == "public":
+        objects = [obj for obj in objects if obj.is_public]
+    elif filters:
         objects = [
             obj for obj in objects if _keep_object(obj.name, filters) or (inherited_members_specified and obj.inherited)
         ]
-    if keep_no_docstrings:
-        return objects
+    if not keep_no_docstrings:
+        objects = [obj for obj in objects if obj.has_docstrings or (inherited_members_specified and obj.inherited)]
+
+    # Prevent infinite recursion.
+    if objects:
+        objects = list(_remove_cycles(objects))
 
-    return [obj for obj in objects if obj.has_docstrings or (inherited_members_specified and obj.inherited)]
+    return objects
 
 
 @lru_cache(maxsize=1)

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/src/mkdocstrings_handlers/python/templates/material/_base/children.html.jinja

@@ -49,7 +49,7 @@ Context:
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for attribute in attributes|order_members(config.members_order, members_list) %}
-                {% if members_list is not none or (not attribute.is_imported or attribute.is_public) %}
+                {% if config.filters == "public" or members_list is not none or (not attribute.is_imported or attribute.is_public) %}
                   {% include attribute|get_template with context %}
                 {% endif %}
               {% endfor %}
@@ -69,7 +69,7 @@ Context:
             {% endif %}
             {% with heading_level = heading_level + extra_level %}
               {% for class in classes|order_members(config.members_order, members_list) %}
-                {% if members_list is not none or (not class.is_imported or class.is_public) %}
+                {% if config.filters == "public" or members_list is not none or (not class.is_imported or class.is_public) %}
                   {% include class|get_template with context %}
                 {% endif %}
               {% endfor %}
@@ -90,7 +90,7 @@ Context:
             {% with heading_level = heading_level + extra_level %}
               {% for function in functions|order_members(config.members_order, members_list) %}
                 {% if not (obj.kind.value == "class" and function.name == "__init__" and config.merge_init_into_class) %}
-                  {% if members_list is not none or (not function.is_imported or function.is_public) %}
+                  {% if config.filters == "public" or members_list is not none or (not function.is_imported or function.is_public) %}
                     {% include function|get_template with context %}
                   {% endif %}
                 {% endif %}
@@ -112,7 +112,7 @@ Context:
               {% endif %}
               {% with heading_level = heading_level + extra_level %}
                 {% for module in modules|order_members("alphabetical", members_list) %}
-                  {% if members_list is not none or (not module.is_alias or module.is_public) %}
+                  {% if config.filters == "public" or members_list is not none or (not module.is_alias or module.is_public) %}
                     {% include module|get_template with context %}
                   {% endif %}
                 {% endfor %}
@@ -137,7 +137,7 @@ Context:
 
         {% if not (obj.is_class and child.name == "__init__" and config.merge_init_into_class) %}
 
-          {% if members_list is not none or child.is_public %}
+          {% if config.filters == "public" or members_list is not none or child.is_public %}
             {% if child.is_attribute %}
               {% with attribute = child %}
                 {% include attribute|get_template with context %}

{mkdocstrings_python-1.16.6 → mkdocstrings_python-1.16.8}/tests/snapshots/__init__.py

@@ -353,5 +353,35 @@ snapshots_members = snapshot(
             ("inherited_members", ()),
             ("members", ()),
         ): external("a185e216dc7b*.html"),
+        (("filters", "public"), ("inherited_members", ("method1",)), ("members", None)): external("6af55596d9c4*.html"),
+        (("filters", "public"), ("inherited_members", ("method1",)), ("members", False)): external(
+            "6abf5ddd819b*.html",
+        ),
+        (("filters", "public"), ("inherited_members", ()), ("members", None)): external("6d72c524b827*.html"),
+        (("filters", "public"), ("inherited_members", False), ("members", False)): external("9dab67183389*.html"),
+        (("filters", "public"), ("inherited_members", ("method1",)), ("members", True)): external("6c0b7207df03*.html"),
+        (("filters", "public"), ("inherited_members", True), ("members", ())): external("f48d651b3f1a*.html"),
+        (("filters", "public"), ("inherited_members", ("method1",)), ("members", ("module_attribute",))): external(
+            "408244423577*.html",
+        ),
+        (("filters", "public"), ("inherited_members", True), ("members", None)): external("16295fa51a2c*.html"),
+        (("filters", "public"), ("inherited_members", True), ("members", True)): external("37232379c426*.html"),
+        (("filters", "public"), ("inherited_members", ()), ("members", ())): external("2e866eca9a45*.html"),
+        (("filters", "public"), ("inherited_members", True), ("members", False)): external("ed5d07bcdbaa*.html"),
+        (("filters", "public"), ("inherited_members", False), ("members", ())): external("135f57223e00*.html"),
+        (("filters", "public"), ("inherited_members", False), ("members", None)): external("b4e20d5cd52e*.html"),
+        (("filters", "public"), ("inherited_members", ()), ("members", False)): external("46daa7e60b98*.html"),
+        (("filters", "public"), ("inherited_members", False), ("members", True)): external("a255ee80bf7a*.html"),
+        (("filters", "public"), ("inherited_members", ()), ("members", True)): external("74e2496015e1*.html"),
+        (("filters", "public"), ("inherited_members", True), ("members", ("module_attribute",))): external(
+            "e254ae60f9af*.html",
+        ),
+        (("filters", "public"), ("inherited_members", ("method1",)), ("members", ())): external("51d73351dc55*.html"),
+        (("filters", "public"), ("inherited_members", ()), ("members", ("module_attribute",))): external(
+            "d56d3aeae22b*.html",
+        ),
+        (("filters", "public"), ("inherited_members", False), ("members", ("module_attribute",))): external(
+            "80399c502938*.html",
+        ),
     },
 )

mkdocstrings_python-1.16.8/tests/snapshots/external/135f57223e006849dcdd1463367127e4c5ee4aba5f12bde17ab3e494dbeed490.html

@@ -0,0 +1,22 @@
+<!--
+{
+  "filters": "public",
+  "inherited_members": false,
+  "members": []
+}
+-->
+
+<div class="doc doc-object doc-module">
+ <h1 class="doc doc-heading" id="members_package">
+  <code>
+   members_package
+  </code>
+ </h1>
+ <div class="doc doc-contents first">
+  <p>
+   Docstring for the package.
+  </p>
+  <div class="doc doc-children">
+  </div>
+ </div>
+</div>