From 5a25486b16e30b5f7e264523e29643b1a638cea9 Mon Sep 17 00:00:00 2001 From: Vyas Ramasubramani Date: Tue, 8 Aug 2023 10:41:07 -0700 Subject: [PATCH] Revert "Remove commented out sections" This reverts commit 534fc3a97339bf68a0b96daae574834b0e6e4fd7. --- doc/source/reference/arrays.rst | 12 +++++++++ doc/source/reference/extensions.rst | 41 +++++++++++++++++++++++++++++ doc/source/reference/index.rst | 19 +++++++++++++ 3 files changed, 72 insertions(+) diff --git a/doc/source/reference/arrays.rst b/doc/source/reference/arrays.rst index 6e1e5856bea25c..2f0f0597c5f24a 100644 --- a/doc/source/reference/arrays.rst +++ b/doc/source/reference/arrays.rst @@ -603,6 +603,18 @@ with a bool :class:`numpy.ndarray`. NA +.. Dtype attributes which are manually listed in their docstrings: including +.. it here to make sure a docstring page is built for them + +.. + .. autosummary:: + :toctree: api/ + + DatetimeTZDtype.unit + DatetimeTZDtype.tz + PeriodDtype.freq + IntervalDtype.subtype + ********* Utilities ********* diff --git a/doc/source/reference/extensions.rst b/doc/source/reference/extensions.rst index 9ee1278e90a6e5..48b95d31601aba 100644 --- a/doc/source/reference/extensions.rst +++ b/doc/source/reference/extensions.rst @@ -25,6 +25,47 @@ objects. api.extensions.ExtensionArray arrays.NumpyExtensionArray +.. We need this autosummary so that methods and attributes are generated. +.. Separate block, since they aren't classes. + + .. autosummary:: + :toctree: api/ + + api.extensions.ExtensionArray._accumulate + api.extensions.ExtensionArray._concat_same_type + api.extensions.ExtensionArray._formatter + api.extensions.ExtensionArray._from_factorized + api.extensions.ExtensionArray._from_sequence + api.extensions.ExtensionArray._from_sequence_of_strings + api.extensions.ExtensionArray._hash_pandas_object + api.extensions.ExtensionArray._reduce + api.extensions.ExtensionArray._values_for_argsort + api.extensions.ExtensionArray._values_for_factorize + api.extensions.ExtensionArray.argsort + api.extensions.ExtensionArray.astype + api.extensions.ExtensionArray.copy + api.extensions.ExtensionArray.view + api.extensions.ExtensionArray.dropna + api.extensions.ExtensionArray.equals + api.extensions.ExtensionArray.factorize + api.extensions.ExtensionArray.fillna + api.extensions.ExtensionArray.insert + api.extensions.ExtensionArray.interpolate + api.extensions.ExtensionArray.isin + api.extensions.ExtensionArray.isna + api.extensions.ExtensionArray.pad_or_backfill + api.extensions.ExtensionArray.ravel + api.extensions.ExtensionArray.repeat + api.extensions.ExtensionArray.searchsorted + api.extensions.ExtensionArray.shift + api.extensions.ExtensionArray.take + api.extensions.ExtensionArray.unique + api.extensions.ExtensionArray.dtype + api.extensions.ExtensionArray.nbytes + api.extensions.ExtensionArray.ndim + api.extensions.ExtensionArray.shape + api.extensions.ExtensionArray.tolist + Additionally, we have some utility methods for ensuring your object behaves correctly. diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index ee4123f6f1ea4b..6d3ce3d31f0050 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -53,3 +53,22 @@ are mentioned in the documentation. options extensions testing + +.. This is to prevent warnings in the doc build. We don't want to encourage +.. these methods. + +.. + .. toctree:: + + api/pandas.Index.holds_integer + api/pandas.Index.nlevels + api/pandas.Index.sort + + +.. Can't convince sphinx to generate toctree for this class attribute. +.. So we do it manually to avoid a warning + +.. + .. toctree:: + + api/pandas.api.extensions.ExtensionDtype.na_value