Skip to content

Add linkable labels to API docs #1941

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
flying-sheep merged 1 commit into from
Mar 28, 2025
Merged

Add linkable labels to API docs #1941

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
12 changes: 12 additions & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ The central class:
AnnData
```

(combining-api)=

## Combining

Combining {class}`AnnData` objects.
Expand All @@ -25,6 +27,8 @@ See also the section on concatenation.
concat
```

(reading-api)=

## Reading

Reading anndata’s native formats `.h5ad` and `zarr`.
Expand Down Expand Up @@ -66,6 +70,8 @@ You might have more success by assembling the {class}`AnnData` object yourself f
io.read_umi_tools
```

(writing-api)=

## Writing

Writing a complete {class}`AnnData` object to disk in anndata’s native formats `.h5ad` and `zarr`.
Expand Down Expand Up @@ -177,6 +183,8 @@ Types used by the former:
experimental.backed._xarray.Dataset2D
```

(errors-api)=

## Errors and warnings

```{eval-rst}
Expand All @@ -186,6 +194,8 @@ Types used by the former:
ImplicitModificationWarning
```

(settings-api)=

## Settings

```{eval-rst}
Expand All @@ -196,6 +206,8 @@ Types used by the former:
settings.override
```

(types-api)=

## Custom Types/Classes for Readable/Writeable Elements

```{eval-rst}
Expand Down