Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
This repository was archived by the owner on May 7, 2026. It is now read-only.

Commit a951249

Browse filesBrowse files
docs: Skip inherited methods, use autosummary only for big classes (#2470)
1 parent f70f93a commit a951249
Copy full SHA for a951249

1 file changed

+13-2Lines changed: 13 additions & 2 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
  • third_party/sphinx/ext/autosummary/templates/autosummary
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎third_party/sphinx/ext/autosummary/templates/autosummary/class.rst‎

Copy file name to clipboardExpand all lines: third_party/sphinx/ext/autosummary/templates/autosummary/class.rst
+13-2Lines changed: 13 additions & 2 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,41 @@
22

33
.. currentmodule:: {{ module }}
44

5+
{% set is_pandas = module.startswith("bigframes.pandas") or module.startswith("bigframes.geopandas") %}
6+
{% set skip_inherited = is_pandas and not module.startswith("bigframes.pandas.typing.api") %}
7+
8+
{% if is_pandas %}
59
.. autoclass:: {{ objname }}
610
:no-members:
711

8-
{% block methods %}
9-
1012
{% block attributes %}
1113
{% if attributes %}
1214
.. rubric:: {{ _('Attributes') }}
1315

1416
.. autosummary::
1517
:toctree:
1618
{% for item in attributes %}
19+
{%- if not skip_inherited or not item in inherited_members%}
1720
~{{ name }}.{{ item }}
21+
{%- endif %}
1822
{%- endfor %}
1923
{% endif %}
2024
{% endblock %}
2125

26+
{% block methods %}
2227
{% if methods %}
2328
.. rubric:: {{ _('Methods') }}
2429

2530
.. autosummary::
2631
:toctree:
32+
2733
{% for item in methods %}
34+
{%- if not skip_inherited or not item in inherited_members%}
2835
~{{ name }}.{{ item }}
36+
{%- endif %}
2937
{%- endfor %}
3038
{% endif %}
3139
{% endblock %}
40+
{% else %}
41+
.. autoclass:: {{ objname }}
42+
{% endif %}

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.