Skip to content

DOC: organise API reference #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lucascolley merged 1 commit into from
Aug 14, 2026
Merged

DOC: organise API reference #920

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 113 additions & 21 deletions docs/api-assorted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,132 @@
# Assorted functions

## Creation functions
Comment on lines 1 to +3

@lucascolley lucascolley Aug 14, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.


```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

angle
apply_where
argpartition
at
atleast_nd
broadcast_shapes
cov
create_diagonal
one_hot
```

## Inspection

```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

default_dtype
```

## Element-wise functions

```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

angle
apply_where

@lucascolley lucascolley Aug 14, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

deg2rad
diag_indices
expand_dims
isclose
isin
kron
nan_to_num
nanmax
nanmin
nansum
nunique
one_hot
pad
partition
rad2deg
searchsorted
setdiff1d
sinc
```

## Indexing functions

```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

at
diag_indices
tril_indices
triu_indices
union1d
unravel_index
```

## Linear algebra functions

```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

kron
```

## Manipulation functions

```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

atleast_nd
broadcast_shapes
expand_dims
pad
```

## Searching functions

```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

searchsorted
```

## Set functions

```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

isin
nunique
setdiff1d
union1d
```

## Sorting functions

```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

argpartition
partition
```

## Statistical functions

```{eval-rst}
.. currentmodule:: array_api_extra
.. autosummary::
:nosignatures:
:toctree: generated

cov
nanmax
nanmin
nansum
```