docs: Improves presentation of NamedTuple subclasses

delb-xml · Jan 17, 2024 · 1adbbce · 1adbbce
1 parent 2fc3040
commit 1adbbce
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 0 deletions.
diff --git a/docs/api/querying.rst b/docs/api/querying.rst
@@ -4,3 +4,4 @@ Queries with XPath & CSS
 ========================
 
 .. automodule:: _delb.xpath
+   :no-inherited-members:
diff --git a/docs/api/typing.rst b/docs/api/typing.rst
@@ -39,3 +39,4 @@ Methods that add nodes to a tree take a variety of input data:
 Definitions that are used for convenient tree building are held in:
 
 .. autoclass:: _delb.nodes._TagDefinition
+   :no-inherited-members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,6 +40,7 @@
 extensions = [
     # in sphinx-extensions
     "class_members_categories",
+    "namedtuples",
     # from the cheeseshop
     "autodocsumm",
     "sphinx_copybutton",

diff --git a/docs/sphinx-extensions/namedtuples.py b/docs/sphinx-extensions/namedtuples.py
@@ -0,0 +1,12 @@
+def setup(app):
+    app.connect("autodoc-process-docstring", namedtuple_strip_alias_reference)
+    return {
+        "version": "0.1",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }
+
+
+def namedtuple_strip_alias_reference(app, what, name, obj, options, lines):
+    if lines and lines[0].startswith("Alias for field number "):
+        lines.clear()