Restructure API documentation into organized sections #10540
Conversation
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Ian Hunt-Isaak <[email protected]> Co-Authored-By: Claude <[email protected]>
Updated all :toctree: directives in API documentation files to point to ../generated/ instead of generated/, ensuring proper inclusion of autogenerated documentation files in the toctree structure. This fixes 940 "document isn't included in any toctree" warnings. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
| CFTimeIndex | ||
| indexes.RangeIndex | ||
| indexes.NDPointIndex |
There was a problem hiding this comment.
Why does the Indexes dropdown (left-hand sidebar only list these 3) but not PandasIndex?... I feel like I'm going crazy and missing something obvious, but why do some left-hand sidebar sub-pages have dropdowns (DataArray, Indexes) and others don't (Dataset, Coordinates)?
There was a problem hiding this comment.
I have no idea, :)
There was a problem hiding this comment.
It does seem like properties are listed in the dropdown, and our accessors are considered properties.
There was a problem hiding this comment.
Restructure API documentation into organized sections with one file per section in api/ subfolder. Note the giant improvement in the left and right sidebars
Agreed this is really nice! A few questions and comments above that could improve it a bit more. Also, while I think the subpages really help organizationally and matches numpy and pandas API docs, there is perhaps also value in a single-page alphabetized list somewhere too (e.g. https://corteva.github.io/rioxarray/stable/modules.html)
🤖 Generated with Claude Code
🤯 This would make for an interesting blog post.
Thanks I addressed most of these. To be clear Claude only cut up one long file in to multiple files :) It didn't make decisions about what went where.
Yeah perhaps. Ours would be very long. |
* main: (94 commits) Restructure API documentation into organized sections (pydata#10540) Fix convert calendar with different dimension name (pydata#10544) Fix kerchunk error in docs build (pydata#10545) Call super().__init__() in st.SearchStrategy subclasses (pydata#10543) CI: update actions location (pydata#10529) meta: Fix labeler topic-documentation (pydata#10524) drop_vars: use emit_user_level_warning (pydata#10528) Pydap flaky tests (pydata#10525) Remove test skip (pydata#10523) Improve warning message and tests for timedelta decoding (pydata#10508) Add dev whats-new (pydata#10522) Add release notes for v2025.07.1 (pydata#10520) Updates for Zarr 3 Dtypes (pydata#10456) Update Custom Indexes section in api.rst (pydata#10517) Expression not assigned (pydata#10507) Raise if `Index.create_variables` returns more variables than passed in through `set_xindex` (pydata#10503) Allow setting (or skipping) new indexes in open_dataset (pydata#8051) doc: add Pandas(Multi)Index to api reference (pydata#10515) Update pre-commit hooks (pydata#10510) Update pre-commit ruff legacy alias (pydata#10511) ...
should we try to customize genindex, then, if that doesn't fit our needs already? |
Restructure API documentation into organized sections with one file per section in api/ subfolder.
Note the giant improvement in the left and right sidebars
before
After
🤖 Generated with Claude Code