From e33fdd402ff7f82241af9e641c7a1b5f3da6e7d0 Mon Sep 17 00:00:00 2001 From: jessicaw9910 Date: Fri, 16 Aug 2024 17:15:20 -0400 Subject: [PATCH] updated API docs --- docs/api.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 51 insertions(+), 3 deletions(-) diff --git a/docs/api.md b/docs/api.md index aca0b43..554d044 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,9 +2,19 @@ ## API Clients -### BioMart +```{eval-rst} +.. module:: nf_rnaseq.api_schema +.. currentmodule:: nf_rnaseq -Supports downloads of +.. autosummary:: + :toctree: generated + + APIClient + APIClientGET + APIClientPOST +``` + +### BioMart ```{eval-rst} .. module:: nf_rnaseq.biomart @@ -13,5 +23,43 @@ Supports downloads of .. autosummary:: :toctree: generated - biomart.BioMart + BioMart +``` + +### HGNC + +```{eval-rst} +.. module:: nf_rnaseq.hgnc +.. currentmodule:: nf_rnaseq + +.. autosummary:: + :toctree: generated + + HGNC +``` + +### UniProt + +```{eval-rst} +.. module:: nf_rnaseq.uniprot +.. currentmodule:: nf_rnaseq + +.. autosummary:: + :toctree: generated + + UniProt + UniProtGET + UniProtPOST +``` + +### Load + +```{eval-rst} +.. module:: nf_rnaseq.load +.. currentmodule:: nf_rnaseq + +.. autosummary:: + :toctree: generated + + literal_eval_list ```