add api doc

telekom · Dec 8, 2023 · 7a2a3e8 · 7a2a3e8
1 parent 4ad8c5b
commit 7a2a3e8
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/Makefile b/Makefile
@@ -20,5 +20,8 @@ test:
 sphinx:
 	poetry run make -C docs clean html
 
+open-sphinx:
+	open docs/build/html/index.html
+
 install:
 	poetry lock && poetry install --all-extras
diff --git a/docs/source/api-reference/data.rst b/docs/source/api-reference/data.rst
@@ -0,0 +1,6 @@
+.. _data_code_doc:
+
+:mod:`~mltb2.data`
+==================
+
+.. automodule:: mltb2.data
diff --git a/mltb2/data.py b/mltb2/data.py
@@ -23,7 +23,8 @@ def _load_colon_data() -> pd.DataFrame:
     """Load colon data (not the labels).
 
     The data is loaded and parsed from the internet.
-    Also see <http://genomics-pubs.princeton.edu/oncology/affydata/index.html>
+    Also see `colon tissues probed by oligonucleotide arrays
+    <http://genomics-pubs.princeton.edu/oncology/affydata/index.html>`_.
 
     Returns:
         data as pandas DataFrame
@@ -54,7 +55,8 @@ def _load_colon_label() -> pd.Series:
     """Load colon label (not the data).
 
     The data is loaded and parsed from the internet.
-    Also see <http://genomics-pubs.princeton.edu/oncology/affydata/index.html>
+    Also see `colon tissues probed by oligonucleotide arrays
+    <http://genomics-pubs.princeton.edu/oncology/affydata/index.html>`_.
 
     Returns:
         labels as pandas Series
@@ -89,7 +91,8 @@ def load_colon() -> Tuple[pd.Series, pd.DataFrame]:
     """Load colon data.
 
     The data is loaded and parsed from the internet.
-    Also see <http://genomics-pubs.princeton.edu/oncology/affydata/index.html>
+    Also see `colon tissues probed by oligonucleotide arrays
+    <http://genomics-pubs.princeton.edu/oncology/affydata/index.html>`_.
 
     Returns:
         Tuple containing labels and data.