Skip to content

Commit 5a25486

Browse files
committed
Revert "Remove commented out sections"
This reverts commit 534fc3a.
1 parent 8b923ff commit 5a25486

File tree

3 files changed

+72
-0
lines changed

3 files changed

+72
-0
lines changed

doc/source/reference/arrays.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -603,6 +603,18 @@ with a bool :class:`numpy.ndarray`.
603603
NA
604604

605605

606+
.. Dtype attributes which are manually listed in their docstrings: including
607+
.. it here to make sure a docstring page is built for them
608+
609+
..
610+
.. autosummary::
611+
:toctree: api/
612+
613+
DatetimeTZDtype.unit
614+
DatetimeTZDtype.tz
615+
PeriodDtype.freq
616+
IntervalDtype.subtype
617+
606618
*********
607619
Utilities
608620
*********

doc/source/reference/extensions.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,47 @@ objects.
2525
api.extensions.ExtensionArray
2626
arrays.NumpyExtensionArray
2727

28+
.. We need this autosummary so that methods and attributes are generated.
29+
.. Separate block, since they aren't classes.
30+
31+
.. autosummary::
32+
:toctree: api/
33+
34+
api.extensions.ExtensionArray._accumulate
35+
api.extensions.ExtensionArray._concat_same_type
36+
api.extensions.ExtensionArray._formatter
37+
api.extensions.ExtensionArray._from_factorized
38+
api.extensions.ExtensionArray._from_sequence
39+
api.extensions.ExtensionArray._from_sequence_of_strings
40+
api.extensions.ExtensionArray._hash_pandas_object
41+
api.extensions.ExtensionArray._reduce
42+
api.extensions.ExtensionArray._values_for_argsort
43+
api.extensions.ExtensionArray._values_for_factorize
44+
api.extensions.ExtensionArray.argsort
45+
api.extensions.ExtensionArray.astype
46+
api.extensions.ExtensionArray.copy
47+
api.extensions.ExtensionArray.view
48+
api.extensions.ExtensionArray.dropna
49+
api.extensions.ExtensionArray.equals
50+
api.extensions.ExtensionArray.factorize
51+
api.extensions.ExtensionArray.fillna
52+
api.extensions.ExtensionArray.insert
53+
api.extensions.ExtensionArray.interpolate
54+
api.extensions.ExtensionArray.isin
55+
api.extensions.ExtensionArray.isna
56+
api.extensions.ExtensionArray.pad_or_backfill
57+
api.extensions.ExtensionArray.ravel
58+
api.extensions.ExtensionArray.repeat
59+
api.extensions.ExtensionArray.searchsorted
60+
api.extensions.ExtensionArray.shift
61+
api.extensions.ExtensionArray.take
62+
api.extensions.ExtensionArray.unique
63+
api.extensions.ExtensionArray.dtype
64+
api.extensions.ExtensionArray.nbytes
65+
api.extensions.ExtensionArray.ndim
66+
api.extensions.ExtensionArray.shape
67+
api.extensions.ExtensionArray.tolist
68+
2869
Additionally, we have some utility methods for ensuring your object
2970
behaves correctly.
3071

doc/source/reference/index.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,22 @@ are mentioned in the documentation.
5353
options
5454
extensions
5555
testing
56+
57+
.. This is to prevent warnings in the doc build. We don't want to encourage
58+
.. these methods.
59+
60+
..
61+
.. toctree::
62+
63+
api/pandas.Index.holds_integer
64+
api/pandas.Index.nlevels
65+
api/pandas.Index.sort
66+
67+
68+
.. Can't convince sphinx to generate toctree for this class attribute.
69+
.. So we do it manually to avoid a warning
70+
71+
..
72+
.. toctree::
73+
74+
api/pandas.api.extensions.ExtensionDtype.na_value

0 commit comments

Comments
 (0)