Skip to content

Commit

Permalink
Add missing link targets
Browse files Browse the repository at this point in the history
  • Loading branch information
flying-sheep committed Oct 26, 2023
1 parent 05564cc commit 07ac415
Show file tree
Hide file tree
Showing 20 changed files with 324 additions and 398 deletions.
13 changes: 5 additions & 8 deletions docs/api/classes.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
## Classes


```{eval-rst}
.. currentmodule:: scanpy
```{currentmodule} scanpy
```

{class}`~anndata.AnnData` is reexported from {mod}`anndata`.

Represent data as a neighborhood structure, usually a knn graph.

```{eval-rst}
.. autosummary::
:nosignatures:
:toctree: ../generated/
Neighbors
```{autosummary}
:nosignatures:
:toctree: ../generated/
Neighbors
```
34 changes: 15 additions & 19 deletions docs/api/datasets.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,23 @@
## Datasets

```{eval-rst}
.. module:: scanpy.datasets
```{module} scanpy.datasets
```

```{eval-rst}
.. currentmodule:: scanpy
```{currentmodule} scanpy
```

```{eval-rst}
.. autosummary::
:nosignatures:
:toctree: ../generated/
datasets.blobs
datasets.ebi_expression_atlas
datasets.krumsiek11
datasets.moignard15
datasets.pbmc3k
datasets.pbmc3k_processed
datasets.pbmc68k_reduced
datasets.paul15
datasets.toggleswitch
datasets.visium_sge
```{autosummary}
:nosignatures:
:toctree: ../generated/
datasets.blobs
datasets.ebi_expression_atlas
datasets.krumsiek11
datasets.moignard15
datasets.pbmc3k
datasets.pbmc3k_processed
datasets.pbmc68k_reduced
datasets.paul15
datasets.toggleswitch
datasets.visium_sge
```
14 changes: 6 additions & 8 deletions docs/api/deprecated.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
## Deprecated functions

```{eval-rst}
.. currentmodule:: scanpy
```{currentmodule} scanpy
```

```{eval-rst}
.. autosummary::
:nosignatures:
:toctree: ../generated/
```{autosummary}
:nosignatures:
:toctree: ../generated/
pp.filter_genes_dispersion
pp.normalize_per_cell
pp.filter_genes_dispersion
pp.normalize_per_cell
```
29 changes: 15 additions & 14 deletions docs/api/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,27 @@

## Experimental

```{eval-rst}
.. module:: scanpy.experimental
.. currentmodule:: scanpy
```{module} scanpy.experimental
```

```{currentmodule} scanpy
```

New methods that are in early development which are not (yet)
integrated in Scanpy core.

```{eval-rst}
.. module:: scanpy.experimental.pp
.. currentmodule:: scanpy
```{module} scanpy.experimental.pp
```

```{currentmodule} scanpy
```

```{eval-rst}
.. autosummary::
:nosignatures:
:toctree: ../generated/
```{autosummary}
:nosignatures:
:toctree: ../generated/
experimental.pp.normalize_pearson_residuals
experimental.pp.normalize_pearson_residuals_pca
experimental.pp.highly_variable_genes
experimental.pp.recipe_pearson_residuals
experimental.pp.normalize_pearson_residuals
experimental.pp.normalize_pearson_residuals_pca
experimental.pp.highly_variable_genes
experimental.pp.recipe_pearson_residuals
```
20 changes: 8 additions & 12 deletions docs/api/get.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
## Get object from `AnnData`: `get`

```{eval-rst}
.. module:: scanpy.get
```{module} scanpy.get
```

```{eval-rst}
.. currentmodule:: scanpy
```{currentmodule} scanpy
```

The module `sc.get` provides convenience functions for getting values back in
useful formats.

```{eval-rst}
.. autosummary::
:nosignatures:
:toctree: ../generated/
get.obs_df
get.var_df
get.rank_genes_groups_df
```{autosummary}
:nosignatures:
:toctree: ../generated/
get.obs_df
get.var_df
get.rank_genes_groups_df
```
20 changes: 8 additions & 12 deletions docs/api/metrics.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
## Metrics

```{eval-rst}
.. module:: scanpy.metrics
```{module} scanpy.metrics
```

```{eval-rst}
.. currentmodule:: scanpy
```{currentmodule} scanpy
```

Collections of useful measurements for evaluating results.

```{eval-rst}
.. autosummary::
:nosignatures:
:toctree: ../generated/
metrics.confusion_matrix
metrics.gearys_c
metrics.morans_i
```{autosummary}
:nosignatures:
:toctree: ../generated/
metrics.confusion_matrix
metrics.gearys_c
metrics.morans_i
```
Loading

0 comments on commit 07ac415

Please sign in to comment.