Merge pull request #14 from tansey-lab/jw_general

updated documentation
tansey-lab · Aug 16, 2024 · f677966 · f677966
2 parents d50229d + 9a532e4
commit f677966
Show file tree

Hide file tree

Showing 4 changed files with 706 additions and 62 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -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
 ```
diff --git a/docs/conf.py b/docs/conf.py
@@ -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),
 }