Skip to content

docs: Skip inherited methods, use autosummary only for big classes #2470

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
TrevorBergeron merged 1 commit into from
Feb 20, 2026
+13 −2
Merged

docs: Skip inherited methods, use autosummary only for big classes #2470

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
15 changes: 13 additions & 2 deletions third_party/sphinx/ext/autosummary/templates/autosummary/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,41 @@

.. currentmodule:: {{ module }}

{% set is_pandas = module.startswith("bigframes.pandas") or module.startswith("bigframes.geopandas") %}
{% set skip_inherited = is_pandas and not module.startswith("bigframes.pandas.typing.api") %}

{% if is_pandas %}
.. autoclass:: {{ objname }}
:no-members:

{% block methods %}

{% block attributes %}
{% if attributes %}
.. rubric:: {{ _('Attributes') }}

.. autosummary::
:toctree:
{% for item in attributes %}
{%- if not skip_inherited or not item in inherited_members%}
~{{ name }}.{{ item }}
{%- endif %}
{%- endfor %}
{% endif %}
{% endblock %}

{% block methods %}
{% if methods %}
.. rubric:: {{ _('Methods') }}

.. autosummary::
:toctree:

{% for item in methods %}
{%- if not skip_inherited or not item in inherited_members%}
~{{ name }}.{{ item }}
{%- endif %}
{%- endfor %}
{% endif %}
{% endblock %}
{% else %}
.. autoclass:: {{ objname }}
{% endif %}
Loading