DOC: organise API reference - #920
Merged
lucascolley merged 1 commit intoAug 14, 2026
Merged
Conversation
lucascolley
approved these changes
Aug 14, 2026
lucascolley
left a comment
lucascolley
left a comment
Member
There was a problem hiding this comment.
Thanks @Johnkothapalli, this seems smoother than I anticipated!
Another opportunity this presents for a follow-up is to reorganise the implementation files accordingly. I'll take a look at that soon.
| :toctree: generated | ||
|
|
||
| angle | ||
| apply_where |
Member
There was a problem hiding this comment.
apply_where is the only one where the category doesn't feel like a great fit to me, but I think it is still arguably the best place for it, so happy to leave it here.
Comment on lines
1
to
+3
| # Assorted functions | ||
|
|
||
| ## Creation functions |
Member
There was a problem hiding this comment.
now that we have this, I think it would be nice to have a multi-level TOC which splits each category into a separate sub-page. I can take a look at doing that in a follow-up.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Organises the flat assorted API autosummary into categories aligned with the Python Array API standard, while keeping a single page and preserving the generated reference URLs. All 31 existing public entries remain listed exactly once.
Closes #322.
The open #910 adds
nanmeanto this file. If it lands first, I will rebase and placenanmeanunder Statistical functions.Validation
pixi run docs(Sphinx with-E -W)pixi run lintAI assistance: Codex helped analyze the grouping and prepare the change; the resulting diff was verified with the project checks above.