Skip to content

Update Custom Indexes section in api.rst - #10517

Merged
dcherian merged 3 commits into
pydata:mainfrom
dcherian:fix-docs-build
Jul 9, 2025
Merged

Update Custom Indexes section in api.rst#10517
dcherian merged 3 commits into
pydata:mainfrom
dcherian:fix-docs-build

Conversation

@dcherian

Copy link
Copy Markdown
Contributor

A couple of xarray-tutorial paths have changed.

@dcherian
dcherian enabled auto-merge (squash) July 9, 2025 14:42
A couple of xarray-tutorial paths have changed.
@dcherian
dcherian disabled auto-merge July 9, 2025 15:03
@dcheriandcherian changed the title Fix docs build.Update Custom Indexes section in api.rstJul 9, 2025
@dcherian
dcherian requested a review from scottyhqJuly 9, 2025 15:25
@scottyhq

Copy link
Copy Markdown
Contributor

A couple of xarray-tutorial paths have changed.

Hmmm, yeah looks like some last minute changes for the scipy 2025 tutorial :) xarray-contrib/xarray-tutorial#334

Comment threaddoc/api.rst Outdated
==============
.. currentmodule:: xarray

Default, pandas-backed indexes built-in to Xarray:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering about renaming this entire section Custom Indexes -> Indexes, and promoting it up so that it's underneath other core data structures (under Coordinates)

Also a quick update here would be nice https://xray--10517.org.readthedocs.build/en/10517/internals/internal-design.html#internal-design (but that can also happen later as part of #10323)

@dcheriandcherianJul 9, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved half of it up, and left the "build new indexes" pieces down where they are now.

The internal design page will require more time than I have now.

@scottyhqscottyhq left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@dcherian
dcherian enabled auto-merge (squash) July 9, 2025 16:51
@dcherian
dcherian merged commit 271ebe9 into pydata:mainJul 9, 2025
dcherian added a commit to jsignell/xarray that referenced this pull request Jul 18, 2025
* 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)
...
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dcherian@scottyhq