DOC: array class docstring pages without autosummary tables
State: closed

See discussion in https://github.com/pandas-dev/pandas/pull/26810

This just adds the "class_without_autosummary". Longer term, we could choose to add certain methods of the Array API to the html api pages, but for now just wanted to do this to get rid of the warnings.

Labels:
name: Docs

Comments:
# [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=h1) Report
> Merging [#26834](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=desc) into [master](https://codecov.io/gh/pandas-dev/pandas/commit/e8132a2901075b96b0d6e74639d5c341bec115fe?src=pr&el=desc) will **increase** coverage by `1.4%`.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/pandas-dev/pandas/pull/26834/graphs/tree.svg?width=650&token=eZ4WkYLtcO&height=150&src=pr)](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=tree)

```diff
@@            Coverage Diff            @@
##           master   #26834     +/-   ##
=========================================
+ Coverage   90.45%   91.86%   +1.4%     
=========================================
  Files         179      179             
  Lines       50706    50706             
=========================================
+ Hits        45866    46579    +713     
+ Misses       4840     4127    -713
```

| Flag | Coverage Δ | |
|---|---|---|
| #multiple | `90.45% <ø> (ø)` | :arrow_up: |
| #single | `41.12% <ø> (?)` | |

| [Impacted Files](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [pandas/core/arrays/integer.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL2ludGVnZXIucHk=) | `96.3% <ø> (ø)` | :arrow_up: |
| [pandas/core/arrays/sparse.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL3NwYXJzZS5weQ==) | `93.71% <ø> (ø)` | :arrow_up: |
| [pandas/core/arrays/timedeltas.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL3RpbWVkZWx0YXMucHk=) | `88.82% <ø> (ø)` | :arrow_up: |
| [pandas/core/arrays/period.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL3BlcmlvZC5weQ==) | `98.54% <ø> (ø)` | :arrow_up: |
| [pandas/core/arrays/numpy\_.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL251bXB5Xy5weQ==) | `94.49% <ø> (ø)` | :arrow_up: |
| [pandas/core/arrays/datetimes.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL2RhdGV0aW1lcy5weQ==) | `97.79% <ø> (ø)` | :arrow_up: |
| [pandas/util/testing.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL3V0aWwvdGVzdGluZy5weQ==) | `90.94% <0%> (+0.1%)` | :arrow_up: |
| [pandas/core/arrays/categorical.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL2NhdGVnb3JpY2FsLnB5) | `95.92% <0%> (+0.12%)` | :arrow_up: |
| [pandas/core/indexes/datetimes.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvaW5kZXhlcy9kYXRldGltZXMucHk=) | `96.37% <0%> (+0.16%)` | :arrow_up: |
| [pandas/io/formats/printing.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2lvL2Zvcm1hdHMvcHJpbnRpbmcucHk=) | `85.56% <0%> (+1.06%)` | :arrow_up: |
| ... and [5 more](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree-more) | |

------

[Continue to review full report at Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=footer). Last update [e8132a2...11fbd96](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).

# [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=h1) Report
> Merging [#26834](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=desc) into [master](https://codecov.io/gh/pandas-dev/pandas/commit/e8132a2901075b96b0d6e74639d5c341bec115fe?src=pr&el=desc) will **increase** coverage by `1.4%`.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/pandas-dev/pandas/pull/26834/graphs/tree.svg?width=650&token=eZ4WkYLtcO&height=150&src=pr)](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=tree)

```diff
@@            Coverage Diff            @@
##           master   #26834     +/-   ##
=========================================
+ Coverage   90.45%   91.85%   +1.4%     
=========================================
  Files         179      179             
  Lines       50706    50700      -6     
=========================================
+ Hits        45866    46572    +706     
+ Misses       4840     4128    -712
```

| Flag | Coverage Δ | |
|---|---|---|
| #multiple | `90.45% <ø> (-0.01%)` | :arrow_down: |
| #single | `41.12% <ø> (?)` | |

| [Impacted Files](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [pandas/core/arrays/integer.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL2ludGVnZXIucHk=) | `96.3% <ø> (ø)` | :arrow_up: |
| [pandas/core/arrays/sparse.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL3NwYXJzZS5weQ==) | `93.59% <ø> (-0.12%)` | :arrow_down: |
| [pandas/core/arrays/timedeltas.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL3RpbWVkZWx0YXMucHk=) | `88.82% <ø> (ø)` | :arrow_up: |
| [pandas/core/arrays/period.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL3BlcmlvZC5weQ==) | `98.3% <ø> (-0.25%)` | :arrow_down: |
| [pandas/core/arrays/numpy\_.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL251bXB5Xy5weQ==) | `94.49% <ø> (ø)` | :arrow_up: |
| [pandas/core/arrays/datetimes.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL2RhdGV0aW1lcy5weQ==) | `97.79% <ø> (ø)` | :arrow_up: |
| [pandas/core/arrays/base.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvYXJyYXlzL2Jhc2UucHk=) | `98.87% <0%> (-0.57%)` | :arrow_down: |
| [pandas/io/formats/format.py](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree#diff-cGFuZGFzL2lvL2Zvcm1hdHMvZm9ybWF0LnB5) | `97.89% <0%> (-0.02%)` | :arrow_down: |
| ... and [11 more](https://codecov.io/gh/pandas-dev/pandas/pull/26834/diff?src=pr&el=tree-more) | |

------

[Continue to review full report at Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=footer). Last update [e8132a2...7ad3b5d](https://codecov.io/gh/pandas-dev/pandas/pull/26834?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).

Looks great, you just need to fix the order of sections in couple of classes, but this fixes all the warnings.

We still have some, but they are unrelated, looks like something is not working for some cases with the "hack" we've got to not have in the API some public methods:
```
checking consistency... /home/vsts/work/1/s/doc/source/reference/api/pandas.Index.asi8.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.Index.holds_integer.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.Index.is_type_compatible.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.Index.nlevels.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.Index.sort.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.api.extensions.ExtensionDtype.na_value.rst: WARNING: document isn't included in any toctree
```

I see most of the methods listed in https://github.com/pandas-dev/pandas/blame/master/doc/source/reference/index.rst#L44 not generating warnings, but those do.

Once we merge this PR and #26810, I'll create issues for the few warnings left, and let's see if we can get a clean build before warnings start reproducing again.
> I see most of the methods listed in https://github.com/pandas-dev/pandas/blame/master/doc/source/reference/index.rst#L44 not generating warnings, but those do.

I suppose we can remove those that generate a warning from that list ... (the reason they get a warning is, I think, because for some reason the class docstring autosummary does not list them. Maybe it has to do with a missing docstring (which could actually be fixed) or otherwise being a special function/attribute object)
Failure is unrelated, seeing it regularly, opened an issue: https://github.com/pandas-dev/pandas/issues/26842