File tree 3 files changed +40
-43
lines changed
3 files changed +40
-43
lines changed Original file line number Diff line number Diff line change 1
- {% extends "!autosummary/class.rst" % }
1
+ {{ fullname | escape | underline} }
2
2
3
- {% block methods %}
4
- {% if methods %}
3
+ .. currentmodule :: {{ module }}
5
4
6
- ..
7
- HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
8
- .. autosummary::
9
- :toctree:
10
- {% for item in all_methods %}
11
- {%- if not item.startswith('_') or item in ['__call__'] %}
12
- {{ name }}.{{ item }}
13
- {%- endif -%}
14
- {%- endfor %}
5
+ .. autoclass :: {{ objname }}
15
6
16
- {% endif %}
17
- {% endblock %}
7
+ {% block methods %}
18
8
19
- {% block attributes %}
20
- {% if attributes %}
9
+ {% block attributes %}
10
+ {% if attributes %}
11
+ .. rubric :: {{ _('Attributes') }}
21
12
22
- ..
23
- HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
24
13
.. autosummary ::
25
- :toctree:
26
- {% for item in all_attributes %}
27
- {%- if not item.startswith('_') %}
28
- {{ name }}.{{ item }}
29
- {%- endif -%}
30
- {%- endfor %}
14
+ {% for item in attributes %}
15
+ {% if item in members and not item.startswith('_') %}
16
+ ~{{ name }}.{{ item }}
17
+ {% endif %}
18
+ {%- endfor %}
19
+ {% endif %}
20
+ {% endblock %}
21
+
22
+ {% if methods %}
23
+ .. rubric :: {{ _('Methods') }}
31
24
32
- {% endif %}
33
- {% endblock %}
25
+ .. autosummary ::
26
+ {% for item in methods %}
27
+ {% if item in members and (not item.startswith('_') or item in ['__call__']) %}
28
+ ~{{ name }}.{{ item }}
29
+ {% endif %}
30
+ {%- endfor %}
31
+ {% endif %}
32
+ {% endblock %}
Original file line number Diff line number Diff line change 76
76
# to ensure that include files (partial pages) aren't built, exclude them
77
77
# https://github.com/sphinx-doc/sphinx/issues/1965#issuecomment-124732907
78
78
"**/includes/**" ,
79
- "**/api/pandas.Series.dt.rst" ,
80
79
]
81
80
try :
82
81
import nbconvert
130
129
autodoc_typehints = "none"
131
130
132
131
# numpydoc
132
+ numpydoc_show_class_members = False
133
+ numpydoc_show_inherited_class_members = False
133
134
numpydoc_attributes_as_param_list = False
134
135
135
136
# matplotlib plot directive
Original file line number Diff line number Diff line change @@ -273,6 +273,19 @@ pandas provides dtype-specific methods under various accessors.
273
273
These are separate namespaces within :class: `Series ` that only apply
274
274
to specific data types.
275
275
276
+ .. autosummary ::
277
+ :toctree: api/
278
+ :nosignatures:
279
+ :template: autosummary/accessor.rst
280
+
281
+ Series.str
282
+ Series.cat
283
+ Series.dt
284
+ Series.sparse
285
+ DataFrame.sparse
286
+ Index.str
287
+
288
+
276
289
=========================== =================================
277
290
Data Type Accessor
278
291
=========================== =================================
@@ -458,22 +471,6 @@ strings and apply several methods to it. These can be accessed like
458
471
Series.str.isdecimal
459
472
Series.str.get_dummies
460
473
461
- ..
462
- The following is needed to ensure the generated pages are created with the
463
- correct template (otherwise they would be created in the Series/Index class page)
464
-
465
- ..
466
- .. autosummary::
467
- :toctree: api/
468
- :template: autosummary/accessor.rst
469
-
470
- Series.str
471
- Series.cat
472
- Series.dt
473
- Series.sparse
474
- DataFrame.sparse
475
- Index.str
476
-
477
474
.. _api.series.cat :
478
475
479
476
Categorical accessor
You can’t perform that action at this time.
0 commit comments