sphinx-autoapi 3.3.0__tar.gz → 3.3.2__tar.gz

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2}/CHANGELOG.rst

@@ -5,6 +5,33 @@ Versions follow `Semantic Versioning <https://semver.org/>`_ (``<major>.<minor>.
 
 .. towncrier release notes start
 
+v3.3.2 (2024-09-25)
+-------------------
+
+Bugfixes
+^^^^^^^^
+
+- Fix types missing from documentation generated by autodoc-style directives. (#473)
+
+
+v3.3.1 (2024-09-01)
+-------------------
+
+Bugfixes
+^^^^^^^^
+
+- Fix all class members missing when documenting a module with the same name as a standard library module
+
+  Members inherited from the standard library can also have their skip value
+  overridden by autoapi-skip-member. (#478)
+
+
+Misc
+^^^^
+
+- Updated all github actions.
+
+
 v3.3.0 (2024-08-28)
 -------------------
 

{sphinx_autoapi-3.3.0/sphinx_autoapi.egg-info → sphinx_autoapi-3.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinx-autoapi
-Version: 3.3.0
+Version: 3.3.2
 Summary: Sphinx API documentation generator
 Home-page: http://github.com/readthedocs/sphinx-autoapi
 Author: Eric Holscher

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2}/autoapi/__init__.py

@@ -3,5 +3,5 @@
 from .extension import setup
 
 __all__ = ("setup",)
-__version__ = "3.3.0"
-__version_info__ = (3, 3, 0)
+__version__ = "3.3.2"
+__version_info__ = (3, 3, 2)

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2}/autoapi/_astroid_utils.py

@@ -644,36 +644,6 @@ def get_return_annotation(node: astroid.nodes.FunctionDef) -> str | None:
     return return_annotation
 
 
-def get_func_docstring(node: astroid.nodes.FunctionDef) -> str:
-    """Get the docstring of a node, using a parent docstring if needed.
-
-    Args:
-        node: The node to get a docstring for.
-
-    Returns:
-        The docstring of the function, or the empty string if no docstring
-        was found or defined.
-    """
-    doc = node.doc_node.value if node.doc_node else ""
-
-    if not doc and isinstance(node.parent, astroid.nodes.ClassDef):
-        for base in node.parent.ancestors():
-            if node.name in ("__init__", "__new__"):
-                base_module = base.qname().split(".", 1)[0]
-                if in_stdlib(base_module):
-                    continue
-
-            for child in base.get_children():
-                if (
-                    isinstance(child, node.__class__)
-                    and child.name == node.name
-                    and child.doc_node is not None
-                ):
-                    return child.doc_node.value
-
-    return doc
-
-
 def get_class_docstring(node: astroid.nodes.ClassDef) -> str:
     """Get the docstring of a node, using a parent docstring if needed.
 

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2}/autoapi/_mapper.py

@@ -5,6 +5,7 @@ import itertools
 import operator
 import os
 import re
+import sys
 
 from jinja2 import Environment, FileSystemLoader
 import sphinx
@@ -31,6 +32,14 @@ from ._objects import (
 )
 from .settings import OWN_PAGE_LEVELS, TEMPLATE_DIR
 
+if sys.version_info < (3, 10):  # PY310
+    from stdlib_list import in_stdlib
+else:
+
+    def in_stdlib(module_name: str) -> bool:
+        return module_name in sys.stdlib_module_names
+
+
 LOGGER = sphinx.util.logging.getLogger(__name__)
 
 
@@ -451,6 +460,24 @@ class Mapper:
             )
         return None
 
+    def _skip_if_stdlib(self):
+        documented_modules = {obj["full_name"] for obj in self.paths.values()}
+
+        q = collections.deque(self.paths.values())
+        while q:
+            obj = q.popleft()
+            if "children" in obj:
+                q.extend(obj["children"])
+
+            if obj.get("inherited", False):
+                module = obj["inherited_from"]["full_name"].split(".", 1)[0]
+                if (
+                    in_stdlib(module)
+                    and not obj["inherited_from"]["is_abstract"]
+                    and module not in documented_modules
+                ):
+                    obj["hide"] = True
+
     def _resolve_placeholders(self):
         """Resolve objects that have been imported from elsewhere."""
         modules = {}
@@ -477,6 +504,7 @@ class Mapper:
                         child["hide"] = True
 
     def map(self, options=None):
+        self._skip_if_stdlib()
         self._resolve_placeholders()
         self._hide_yo_kids()
         self.app.env.autoapi_annotations = {}

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2}/autoapi/_parser.py

@@ -1,7 +1,5 @@
 import collections
-import itertools
 import os
-import sys
 
 import astroid
 import astroid.builder
@@ -10,14 +8,6 @@ import sphinx.util.docstrings
 from . import _astroid_utils
 
 
-if sys.version_info < (3, 10):  # PY310
-    from stdlib_list import in_stdlib
-else:
-
-    def in_stdlib(module_name: str) -> bool:
-        return module_name in sys.stdlib_module_names
-
-
 def _prepare_docstring(doc):
     return "\n".join(sphinx.util.docstrings.prepare_docstring(doc))
 
@@ -117,55 +107,69 @@ class Parser:
 
         return [data]
 
-    def parse_classdef(self, node, data=None):
+    def _parse_classdef(self, node, use_name_stacks):
+        if use_name_stacks:
+            qual_name = self._get_qual_name(node.name)
+            full_name = self._get_full_name(node.name)
+
+            self._qual_name_stack.append(node.name)
+            self._full_name_stack.append(node.name)
+        else:
+            qual_name = node.qname()[len(node.root().qname()) + 1 :]
+            full_name = node.qname()
+
         type_ = "class"
         if _astroid_utils.is_exception(node):
             type_ = "exception"
 
-        basenames = list(_astroid_utils.get_full_basenames(node))
-
         data = {
             "type": type_,
             "name": node.name,
-            "qual_name": self._get_qual_name(node.name),
-            "full_name": self._get_full_name(node.name),
-            "bases": basenames,
+            "qual_name": qual_name,
+            "full_name": full_name,
+            "bases": list(_astroid_utils.get_full_basenames(node)),
             "doc": _prepare_docstring(_astroid_utils.get_class_docstring(node)),
             "from_line_no": node.fromlineno,
             "to_line_no": node.tolineno,
             "children": [],
+            "is_abstract": _astroid_utils.is_abstract_class(node),
         }
 
-        self._qual_name_stack.append(node.name)
-        self._full_name_stack.append(node.name)
-        overridden = set()
         overloads = {}
+        for child in node.get_children():
+            children_data = self.parse(child)
+            for child_data in children_data:
+                if _parse_child(child_data, overloads):
+                    data["children"].append(child_data)
+
+        data["children"] = list(self._resolve_inheritance(data))
+
+        return data
+
+    def _resolve_inheritance(self, *mro_data):
+        overridden = set()
         children = {}
-        for base in itertools.chain(iter((node,)), node.ancestors()):
+        for i, cls_data in enumerate(mro_data):
             seen = set()
             base_children = []
+            overloads = {}
 
-            # Don't document members inherited from standard library classes
-            # unless that class is abstract.
-            base_module = base.qname().split(".", 1)[0]
-            if in_stdlib(base_module) and not _astroid_utils.is_abstract_class(base):
-                continue
-
-            for child in base.get_children():
-                children_data = self.parse(child)
-                for child_data in children_data:
-                    name = child_data["name"]
+            for child_data in cls_data["children"]:
+                name = child_data["name"]
 
-                    existing_child = children.get(name)
-                    if existing_child and not existing_child["doc"]:
-                        existing_child["doc"] = child_data["doc"]
+                existing_child = children.get(name)
+                if existing_child and not existing_child["doc"]:
+                    existing_child["doc"] = child_data["doc"]
 
-                    if name in overridden:
-                        continue
+                if name in overridden:
+                    continue
 
-                    seen.add(name)
-                    if _parse_child(node, child_data, overloads, base):
-                        base_children.append(child_data)
+                seen.add(name)
+                if _parse_child(child_data, overloads):
+                    base_children.append(child_data)
+                    child_data["inherited"] = i != 0
+                    if child_data["inherited"]:
+                        child_data["inherited_from"] = cls_data
 
             overridden.update(seen)
 
@@ -185,7 +189,29 @@ class Parser:
 
                 children[base_child["name"]] = base_child
 
-        data["children"].extend(children.values())
+        return children.values()
+
+    def _relevant_ancestors(self, node):
+        for base in node.ancestors():
+            if base.qname() in (
+                "__builtins__.object",
+                "builtins.object",
+                "builtins.type",
+            ):
+                continue
+
+            yield base
+
+    def parse_classdef(self, node):
+        data = self._parse_classdef(node, use_name_stacks=True)
+
+        ancestors = self._relevant_ancestors(node)
+        ancestor_data = [
+            self._parse_classdef(base, use_name_stacks=False) for base in ancestors
+        ]
+        if ancestor_data:
+            data["children"] = list(self._resolve_inheritance(data, *ancestor_data))
+
         self._qual_name_stack.pop()
         self._full_name_stack.pop()
 
@@ -227,7 +253,7 @@ class Parser:
             "qual_name": self._get_qual_name(node.name),
             "full_name": self._get_full_name(node.name),
             "args": _astroid_utils.get_args_info(node.args),
-            "doc": _prepare_docstring(_astroid_utils.get_func_docstring(node)),
+            "doc": _prepare_docstring(node.doc_node.value if node.doc_node else ""),
             "from_line_no": node.fromlineno,
             "to_line_no": node.tolineno,
             "return_annotation": _astroid_utils.get_return_annotation(node),
@@ -302,7 +328,7 @@ class Parser:
                 children_data = self.parse(child)
 
             for child_data in children_data:
-                if _parse_child(node, child_data, overloads):
+                if _parse_child(child_data, overloads):
                     data["children"].append(child_data)
 
         return data
@@ -352,7 +378,7 @@ class Parser:
         return data
 
 
-def _parse_child(node, child_data, overloads, base=None) -> bool:
+def _parse_child(child_data, overloads) -> bool:
     if child_data["type"] in ("function", "method", "property"):
         name = child_data["name"]
         if name in overloads:
@@ -369,7 +395,4 @@ def _parse_child(node, child_data, overloads, base=None) -> bool:
         if child_data["is_overload"] and name not in overloads:
             overloads[name] = child_data
 
-    if base:
-        child_data["inherited"] = base is not node
-
     return True

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2}/autoapi/documenters.py

@@ -98,7 +98,7 @@ class _AutoapiDocstringSignatureMixin:
 
 
 class AutoapiFunctionDocumenter(
-    AutoapiDocumenter, autodoc.FunctionDocumenter, _AutoapiDocstringSignatureMixin
+    AutoapiDocumenter, _AutoapiDocstringSignatureMixin, autodoc.FunctionDocumenter
 ):
     objtype = "apifunction"
     directivetype = "function"
@@ -147,9 +147,7 @@ class AutoapiDecoratorDocumenter(
         return "(" + to_format + ")"
 
 
-class AutoapiClassDocumenter(
-    AutoapiDocumenter, autodoc.ClassDocumenter, _AutoapiDocstringSignatureMixin
-):
+class AutoapiClassDocumenter(AutoapiDocumenter, autodoc.ClassDocumenter):
     objtype = "apiclass"
     directivetype = "class"
     doc_as_attr = False
@@ -174,9 +172,18 @@ class AutoapiClassDocumenter(
                 bases = ", ".join(f":class:`{base}`" for base in self.object.bases)
                 self.add_line(f"   Bases: {bases}", sourcename)
 
+    def format_signature(self, **kwargs):
+        # Set "manual" attributes at the last possible moment.
+        # This is to let a manual entry or docstring searching happen first,
+        # and falling back to the discovered signature only when necessary.
+        if self.args is None:
+            self.args = self.object.args
+
+        return super().format_signature(**kwargs)
+
 
 class AutoapiMethodDocumenter(
-    AutoapiDocumenter, autodoc.MethodDocumenter, _AutoapiDocstringSignatureMixin
+    AutoapiDocumenter, _AutoapiDocstringSignatureMixin, autodoc.MethodDocumenter
 ):
     objtype = "apimethod"
     directivetype = "method"
@@ -230,9 +237,6 @@ class AutoapiPropertyDocumenter(AutoapiDocumenter, autodoc.PropertyDocumenter):
         autodoc.ClassLevelDocumenter.add_directive_header(self, sig)
 
         sourcename = self.get_sourcename()
-        if self.options.annotation and self.options.annotation is not autodoc.SUPPRESS:
-            self.add_line(f"   :type: {self.options.annotation}", sourcename)
-
         for property_type in (
             "abstractmethod",
             "classmethod",
@@ -240,6 +244,9 @@ class AutoapiPropertyDocumenter(AutoapiDocumenter, autodoc.PropertyDocumenter):
             if property_type in self.object.properties:
                 self.add_line(f"   :{property_type}:", sourcename)
 
+        if self.object.annotation:
+            self.add_line(f"   :type: {self.object.annotation}", sourcename)
+
 
 class AutoapiDataDocumenter(AutoapiDocumenter, autodoc.DataDocumenter):
     objtype = "apidata"
@@ -254,14 +261,16 @@ class AutoapiDataDocumenter(AutoapiDocumenter, autodoc.DataDocumenter):
         autodoc.ModuleLevelDocumenter.add_directive_header(self, sig)
         sourcename = self.get_sourcename()
         if not self.options.annotation:
-            # TODO: Change sphinx to allow overriding of object description
             if self.object.value is not None:
-                self.add_line(f"   :annotation: = {self.object.value}", sourcename)
+                self.add_line(f"   :value: {self.object.value}", sourcename)
         elif self.options.annotation is autodoc.SUPPRESS:
             pass
         else:
             self.add_line(f"   :annotation: {self.options.annotation}", sourcename)
 
+        if self.object.annotation:
+            self.add_line(f"   :type: {self.object.annotation}", sourcename)
+
 
 class AutoapiAttributeDocumenter(AutoapiDocumenter, autodoc.AttributeDocumenter):
     objtype = "apiattribute"
@@ -277,14 +286,16 @@ class AutoapiAttributeDocumenter(AutoapiDocumenter, autodoc.AttributeDocumenter)
         autodoc.ClassLevelDocumenter.add_directive_header(self, sig)
         sourcename = self.get_sourcename()
         if not self.options.annotation:
-            # TODO: Change sphinx to allow overriding of object description
             if self.object.value is not None:
-                self.add_line(f"   :annotation: = {self.object.value}", sourcename)
+                self.add_line(f"   :value: {self.object.value}", sourcename)
         elif self.options.annotation is autodoc.SUPPRESS:
             pass
         else:
             self.add_line(f"   :annotation: {self.options.annotation}", sourcename)
 
+        if self.object.annotation:
+            self.add_line(f"   :type: {self.object.annotation}", sourcename)
+
 
 class AutoapiModuleDocumenter(AutoapiDocumenter, autodoc.ModuleDocumenter):
     objtype = "apimodule"

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2/sphinx_autoapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinx-autoapi
-Version: 3.3.0
+Version: 3.3.2
 Summary: Sphinx API documentation generator
 Home-page: http://github.com/readthedocs/sphinx-autoapi
 Author: Eric Holscher

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2}/sphinx_autoapi.egg-info/SOURCES.txt

@@ -116,6 +116,11 @@ tests/python/pypackageexample/package/subpackage/submodule.py
 tests/python/pyskipexample/conf.py
 tests/python/pyskipexample/index.rst
 tests/python/pyskipexample/example/example.py
+tests/python/pystdlib/conf.py
+tests/python/pystdlib/index.rst
+tests/python/pystdlib/stdlib/json.py
+tests/python/pystdlib/stdlib/myast.py
+tests/python/pystdlib/stdlib/myjson.py
 tests/templateexample/conf.py
 tests/templateexample/index.rst
 tests/templateexample/example/example.py

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2}/tests/python/conftest.py

@@ -1,8 +1,6 @@
-import io
 import os
 import pathlib
 import shutil
-from unittest.mock import call
 
 from bs4 import BeautifulSoup
 import pytest

{sphinx_autoapi-3.3.0/tests/python/pymovedconfpy → sphinx_autoapi-3.3.2/tests/python/pyexample}/example/example.py

@@ -3,6 +3,7 @@
 This is a description
 """
 
+from dataclasses import dataclass
 from functools import cached_property
 
 A_TUPLE = ("a", "b")
@@ -171,3 +172,26 @@ def fn_with_long_sig(
     arguments
 ):
     """A function with a long signature."""
+
+
+TYPED_DATA: int = 1
+"""This is TYPED_DATA."""
+
+
+@dataclass
+class TypedAttrs:
+    one: str
+    """This is TypedAttrs.one."""
+    two: int = 1
+    """This is TypedAttrs.two."""
+
+
+class TypedClassInit:
+    """This is TypedClassInit."""
+
+    def __init__(self, one: int = 1) -> None:
+        self._one = one
+
+    def typed_method(self, two: int) -> int:
+        """This is TypedClassInit.typed_method."""
+        return self._one + two

{sphinx_autoapi-3.3.0/tests/python/pyexample → sphinx_autoapi-3.3.2/tests/python/pymovedconfpy}/example/example.py

@@ -3,6 +3,7 @@
 This is a description
 """
 
+from dataclasses import dataclass
 from functools import cached_property
 
 A_TUPLE = ("a", "b")
@@ -171,3 +172,26 @@ def fn_with_long_sig(
     arguments
 ):
     """A function with a long signature."""
+
+
+TYPED_DATA: int = 1
+"""This is TYPED_DATA."""
+
+
+@dataclass
+class TypedAttrs:
+    one: str
+    """This is TypedAttrs.one."""
+    two: int = 1
+    """This is TypedAttrs.two."""
+
+
+class TypedClassInit:
+    """This is TypedClassInit."""
+
+    def __init__(self, one: int = 1) -> None:
+        self._one = one
+
+    def typed_method(self, two: int) -> int:
+        """This is TypedClassInit.typed_method."""
+        return self._one + two

sphinx_autoapi-3.3.2/tests/python/pystdlib/conf.py

@@ -0,0 +1,24 @@
+templates_path = ["_templates"]
+source_suffix = ".rst"
+master_doc = "index"
+project = "pystdlib"
+copyright = "2015, readthedocs"
+author = "readthedocs"
+version = "0.1"
+release = "0.1"
+language = "en"
+exclude_patterns = ["_build"]
+pygments_style = "sphinx"
+todo_include_todos = False
+html_theme = "alabaster"
+htmlhelp_basename = "pystdlibdoc"
+extensions = ["autoapi.extension"]
+autoapi_dirs = ["stdlib"]
+autoapi_file_pattern = "*.py"
+autoapi_keep_files = True
+autoapi_options = [
+    "members",
+    "undoc-members" "special-members",
+    "imported-members",
+    "inherited-members",
+]

sphinx_autoapi-3.3.2/tests/python/pystdlib/index.rst

@@ -0,0 +1,25 @@
+.. pypackageexample documentation master file, created by
+   sphinx-quickstart on Fri May 29 13:34:37 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pypackageexample's documentation!
+============================================
+
+.. toctree::
+
+   autoapi/index
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

sphinx_autoapi-3.3.2/tests/python/pystdlib/stdlib/json.py

@@ -0,0 +1,9 @@
+"""json is the same name as a stdlib module."""
+
+
+class JSONDecoder:
+    """Do things with json."""
+
+    def decode(self, s):
+        """Decode a string."""
+        return s

sphinx_autoapi-3.3.2/tests/python/pystdlib/stdlib/myast.py

@@ -0,0 +1,10 @@
+"""This is a docstring."""
+
+import ast
+
+
+class MyVisitor(ast.NodeVisitor):
+    """My custom visitor."""
+
+    def my_visit(self):
+        """My visit method."""

sphinx_autoapi-3.3.2/tests/python/pystdlib/stdlib/myjson.py

@@ -0,0 +1,10 @@
+"""This is a docstring."""
+
+from json import JSONDecoder
+
+
+class MyJSONDecoder(JSONDecoder):
+    """This is a class."""
+
+    def my_method(self):
+        """This is a method."""

{sphinx_autoapi-3.3.0 → sphinx_autoapi-3.3.2}/tests/python/test_pyintegration.py

@@ -1,4 +1,3 @@
-import io
 import os
 import pathlib
 import sys
@@ -178,6 +177,74 @@ class TestSimpleModuleManual:
         example_file = parse("_build/html/manualapi.html")
         assert example_file.find(id="example.decorator_okay")
 
+    def test_dataclass(self, parse):
+        example_file = parse("_build/html/manualapi.html")
+
+        typedattrs_sig = example_file.find(id="example.TypedAttrs")
+        assert typedattrs_sig
+
+        typedattrs = typedattrs_sig.parent
+
+        one = typedattrs.find(id="example.TypedAttrs.one")
+        assert one
+        one_value = one.find_all(class_="property")
+        assert one_value[0].text == ": str"
+        one_docstring = one.parent.find("dd").contents[0].text
+        assert one_docstring.strip() == "This is TypedAttrs.one."
+
+        two = typedattrs.find(id="example.TypedAttrs.two")
+        assert two
+        two_value = two.find_all(class_="property")
+        assert two_value[0].text == ": int"
+        assert two_value[1].text == " = 1"
+        two_docstring = two.parent.find("dd").contents[0].text
+        assert two_docstring.strip() == "This is TypedAttrs.two."
+
+    def test_data(self, parse):
+        example_file = parse("_build/html/manualapi.html")
+
+        typed_data = example_file.find(id="example.TYPED_DATA")
+        assert typed_data
+        typed_data_value = typed_data.find_all(class_="property")
+        assert typed_data_value[0].text == ": int"
+        assert typed_data_value[1].text == " = 1"
+
+        typed_data_docstring = typed_data.parent.find("dd").contents[0].text
+        assert typed_data_docstring.strip() == "This is TYPED_DATA."
+
+    def test_class(self, parse):
+        example_file = parse("_build/html/manualapi.html")
+
+        typed_cls = example_file.find(id="example.TypedClassInit")
+        assert typed_cls
+        arg = typed_cls.find(class_="sig-param")
+        assert arg.text == "one: int = 1"
+        typed_cls_docstring = typed_cls.parent.find("dd").contents[0].text
+        assert typed_cls_docstring.strip() == "This is TypedClassInit."
+
+        typed_method = example_file.find(id="example.TypedClassInit.typed_method")
+        assert typed_method
+        arg = typed_method.find(class_="sig-param")
+        assert arg.text == "two: int"
+        return_type = typed_method.find(class_="sig-return-typehint")
+        assert return_type.text == "int"
+        typed_method_docstring = typed_method.parent.find("dd").contents[0].text
+        assert typed_method_docstring.strip() == "This is TypedClassInit.typed_method."
+
+    def test_property(self, parse):
+        example_file = parse("_build/html/manualapi.html")
+
+        foo_sig = example_file.find(id="example.Foo")
+        assert foo_sig
+        foo = foo_sig.parent
+
+        property_simple = foo.find(id="example.Foo.property_simple")
+        assert property_simple
+        property_simple_value = property_simple.find_all(class_="property")
+        assert property_simple_value[-1].text == ": int"
+        property_simple_docstring = property_simple.parent.find("dd").text.strip()
+        assert property_simple_docstring == "This property should parse okay."
+
 
 class TestMovedConfPy(TestSimpleModule):
     @pytest.fixture(autouse=True, scope="class")
@@ -1243,3 +1310,51 @@ def test_nothing_to_render_raises_warning(builder):
         builder("pynorender", warningiserror=True)
 
     assert "No modules were rendered" in str(exc_info.value)
+
+
+class TestStdLib:
+    """Check that modules with standard library names are still documented."""
+
+    @pytest.fixture(autouse=True)
+    def built(self, builder):
+        builder("pystdlib")
+
+    def test_integration(self, parse):
+        json_file = parse("_build/html/autoapi/json/index.html")
+
+        json_mod = json_file.find(id="json")
+        assert "json is the same name" in json_mod.parent.text
+
+        assert json_file.find(id="json.JSONDecoder")
+        decode = json_file.find(id="json.JSONDecoder.decode")
+        assert decode
+        wrap_docstring = decode.parent.find("dd").text.strip()
+        assert wrap_docstring == "Decode a string."
+
+        myjson_file = parse("_build/html/autoapi/myjson/index.html")
+
+        # Find members that are not inherited from local standard library classes.
+        ctx = myjson_file.find(id="myjson.MyJSONDecoder")
+        assert ctx
+        meth = myjson_file.find(id="myjson.MyJSONDecoder.my_method")
+        assert meth
+        meth_docstring = meth.parent.find("dd").text.strip()
+        assert meth_docstring == "This is a method."
+
+        # Find members that are inherited from local standard library classes.
+        decode = myjson_file.find(id="myjson.MyJSONDecoder.decode")
+        assert decode
+
+        myast_file = parse("_build/html/autoapi/myast/index.html")
+
+        # Find members that are not inherited from standard library classes.
+        visitor = myast_file.find(id="myast.MyVisitor")
+        assert visitor
+        meth = myast_file.find(id="myast.MyVisitor.my_visit")
+        assert meth
+        meth_docstring = meth.parent.find("dd").text.strip()
+        assert meth_docstring == "My visit method."
+
+        # Find members that are inherited from standard library classes.
+        meth = myast_file.find(id="myast.MyVisitor.visit")
+        assert not meth