Skip to content

docs(api): drop the "Bases: object" line from every class page #583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
breimanntools merged 1 commit into from
Sep 18, 2026
Merged

docs(api): drop the "Bases: object" line from every class page #583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/source/_templates/autosummary/class_template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
.. autoclass:: {{ objname }}
:members: __init__
:exclude-members: {{ methods|join(', ') }}
:show-inheritance:

{% block methods %}
{% if methods %}
Expand Down
6 changes: 5 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,11 @@
"private-members": False,
"special-members": "",
"inherited-members": False, # Document members that are inherited from the base class
"show-inheritance": False, # Show the base classes in the documentation for a class
# NOTE: "show-inheritance" is deliberately ABSENT. In autodoc_default_options a flag is
# enabled by the KEY'S PRESENCE, so `"show-inheritance": False` switched it ON and put a
# "Bases: object" line on every class page. Every public class here derives from `object`
# or an internal template ABC, so that line is pure noise. Do not re-add the key, and keep
# `:show-inheritance:` out of _templates/autosummary/class_template.rst as well.
"ignore-module-all": False, # Ignore __all__ when looking for members to document
"exclude-members": "",
"autodoc_typehints": "description",
Expand Down
Loading