Skip to content

Commit

Permalink
docs: new api documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
matq007 committed Sep 13, 2024
1 parent d47f318 commit 538e56a
Show file tree
Hide file tree
Showing 3 changed files with 233 additions and 124 deletions.
32 changes: 31 additions & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,35 @@
# API

## scanvi_explainer

### Utilities: `utils`

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

```{eval-rst}
.. autosummary::
:toctree: generated
:nosignatures:
utils.train_test_group_split
```

### Plots: `plots`

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

```{eval-rst}
.. autosummary::
:toctree: generated
:nosignatures:
plots.feature_plot
```

## SCANVIDeep

```{eval-rst}
Expand All @@ -12,4 +42,4 @@
:nosignatures:
scanvi_deep
```
```
12 changes: 8 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,14 @@
}

intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"anndata": ("https://anndata.readthedocs.io/en/stable/", None),
"scanpy": ("https://scanpy.readthedocs.io/en/stable/", None),
"huggingface_hub": ("https://huggingface.co/docs/huggingface_hub/main/en", None),
"matplotlib": ("https://matplotlib.org/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"pandas": ("https://pandas.pydata.org/docs/", None),
"python": ("https://docs.python.org/3", None),
"sklearn": ("https://scikit-learn.org/stable/", None),
"torch": ("https://pytorch.org/docs/master/", None),
}

# List of patterns, relative to source directory, that match files and
Expand Down Expand Up @@ -119,5 +123,5 @@
nitpick_ignore = [
# If building the documentation fails because of a missing link that is outside your control,
# you can add an exception to this list.
# ("py:class", "igraph.Graph"),
]
("optional"),
]
Loading

0 comments on commit 538e56a

Please sign in to comment.