Skip to content

Commit

Permalink
fix: added link to live documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
matq007 committed Sep 12, 2024
1 parent fc33bb7 commit c3863a4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# scanvi-explainer

[![build][build-badge]][build-link]
[![Documentation Status][docs]][docs-link]

Interpretability extension for [scANVI] using [SHAP] package.

Expand All @@ -19,6 +20,12 @@ $ git clone https://github.com/brickmanlab/scanvi-explainer.git && cd scanvi-exp
$ uv sync
```

## Build documentation

```console
$ sphinx-build -M html docs docs/_build
```

## Citation

Please consider citing scANVI Explainer if you use in your research.
Expand All @@ -41,6 +48,8 @@ Please consider citing scANVI Explainer if you use in your research.
}
```

[docs]: https://readthedocs.org/projects/scanvi-explainer/badge/?version=latest
[docs-link]: https://scanvi-explainer.readthedocs.io/en/latest/?badge=latest
[build-badge]: https://github.com/brickmanlab/scanvi-explainer/actions/workflows/build.yml/badge.svg
[build-link]: https://github.com/brickmanlab/scanvi-explainer/actions/workflows/build.yml
[scANVI]: https://docs.scvi-tools.org/en/stable/api/reference/scvi.model.SCANVI.html#scvi.model.SCANVI
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ classifiers = [

[project.urls]
Homepage = "https://github.com/brickmanlab/scanvi-explainer"
Documentation = "https://readthedocs.org"
Documentation = "https://scanvi-explainer.readthedocs.io"
Repository = "https://github.com/brickmanlab/scanvi-explainer.git"
Issues = "https://github.com/brickmanlab/scanvi-explainer/issues"
Changelog = "https://github.com/brickmanlab/scanvi-explainer/blob/master/CHANGELOG.md"
Expand Down

0 comments on commit c3863a4

Please sign in to comment.