From e2a84fb9b44fc083bf5938f403a7c63c1f233f58 Mon Sep 17 00:00:00 2001 From: jessicaw9910 Date: Fri, 16 Aug 2024 17:43:09 -0400 Subject: [PATCH] updated API docs --- docs/api.md | 18 +++++++++--------- docs/conf.py | 4 ++++ 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/api.md b/docs/api.md index 9a380c4..7ab38f1 100644 --- a/docs/api.md +++ b/docs/api.md @@ -8,10 +8,9 @@ .. autosummary:: :toctree: generated + :recursive: - api_schema.APIClient - api_schema.APIClientGET - api_schema.APIClientPOST + api_schema ``` ### BioMart @@ -22,8 +21,9 @@ .. autosummary:: :toctree: generated + :recursive: - biomart.BioMart + biomart ``` ### HGNC @@ -35,7 +35,7 @@ .. autosummary:: :toctree: generated - hgnc.HGNC + hgnc ``` ### UniProt @@ -46,10 +46,9 @@ .. autosummary:: :toctree: generated + :recursive: - uniprot.UniProt - uniprot.UniProtGET - uniprot.UniProtPOST + uniprot ``` ### Load @@ -60,6 +59,7 @@ .. autosummary:: :toctree: generated + :recursive: - load.literal_eval_list + load ``` diff --git a/docs/conf.py b/docs/conf.py index 0eecc2c..cb6e33c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -127,3 +127,7 @@ # you can add an exception to this list. # ("py:class", "igraph.Graph"), ] + +suppress_warnings = [ + "autosummary.import_cycle", +]