Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jessicaw9910 committed Aug 16, 2024
1 parent d50229d commit 9a532e4
Show file tree
Hide file tree
Showing 4 changed files with 706 additions and 62 deletions.
31 changes: 5 additions & 26 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,17 @@
# API

## Preprocessing
## API Clients

```{eval-rst}
.. module:: nf_rnaseq.pp
.. currentmodule:: nf_rnaseq
.. autosummary::
:toctree: generated
pp.basic_preproc
```

## Tools

```{eval-rst}
.. module:: nf_rnaseq.tl
.. currentmodule:: nf_rnaseq
.. autosummary::
:toctree: generated
tl.basic_tool
```
### BioMart

## Plotting
Supports downloads of

```{eval-rst}
.. module:: nf_rnaseq.pl
.. module:: nf_rnaseq.biomart
.. currentmodule:: nf_rnaseq
.. autosummary::
:toctree: generated
pl.basic_plot
pl.BasicClass
biomart.BioMart
```
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@

intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"anndata": ("https://anndata.readthedocs.io/en/stable/", None),
# "anndata": ("https://anndata.readthedocs.io/en/stable/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
}

Expand Down
Loading

0 comments on commit 9a532e4

Please sign in to comment.