#57 fix doc import errors and organize default index

scribe-org · Feb 24, 2024 · 9ce0e76 · 9ce0e76
1 parent e994400
commit 9ce0e76
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 24 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -41,7 +41,8 @@
 Wikidata and Wikipedia language data extraction
 
 Installation
-------------
+============
+
 .. code-block:: shell
 
     pip install scribe-data
@@ -56,14 +57,20 @@ Installation
 
     import scribe_data
 
+Contents
+========
+
+.. toctree::
+    :maxdepth: 2
+
+    scribe_data/index
+
+Contributing
+============
+
 .. toctree::
     :maxdepth: 2
-    :caption: Contents
 
-    extract_transform/index
-    load/index
-    checkquery
-    utils
     notes
 
 Project Indices

diff --git a/docs/source/notes.rst b/docs/source/notes.rst
@@ -1,9 +1,9 @@
-.. mdinclude:: ../../.github/docs/CONTRIBUTING_NO_BACK_LINKS.md
-
 License
 =======
 
 .. literalinclude:: ../../LICENSE.txt
     :language: text
 
+.. mdinclude:: ../../.github/docs/CONTRIBUTING_NO_BACK_LINKS.md
+
 .. mdinclude:: ../../CHANGELOG.md
diff --git a/docs/source/checkquery.rst → docs/source/scribe_data/checkquery.rst b/docs/source/checkquery.rst → docs/source/scribe_data/checkquery.rst
diff --git a/docs/source/extract_transform/index.rst → ...e/scribe_data/extract_transform/index.rst b/docs/source/extract_transform/index.rst → ...e/scribe_data/extract_transform/index.rst
diff --git a/docs/source/scribe_data/index.rst b/docs/source/scribe_data/index.rst
@@ -0,0 +1,10 @@
+scribe_data
+===========
+
+.. toctree::
+    :maxdepth: 1
+
+    extract_transform/index
+    load/index
+    checkquery
+    utils
diff --git a/docs/source/load/index.rst → docs/source/scribe_data/load/index.rst b/docs/source/load/index.rst → docs/source/scribe_data/load/index.rst
diff --git a/docs/source/utils.rst → docs/source/scribe_data/utils.rst b/docs/source/utils.rst → docs/source/scribe_data/utils.rst
diff --git a/src/scribe_data/checkquery.py b/src/scribe_data/checkquery.py
@@ -296,13 +296,13 @@ def check_positive_int(value: str, err_msg: str) -> int:
         err_msg : str
             Used when value fails validation.
 
-    Raises
-    ------
-        argparse.ArgumentTypeError
-
     Returns
     -------
         int : the validated number.
+
+    Raises
+    ------
+        argparse.ArgumentTypeError
     """
     try:
         number = int(value)
@@ -323,13 +323,13 @@ def check_limit(limit: str) -> int:
         limit : str
             The LIMIT to be validated.
 
-    Raises
-    ------
-        argparse.ArgumentTypeError
-
     Returns
     -------
         int : the validated LIMIT.
+
+    Raises
+    ------
+        argparse.ArgumentTypeError
     """
     return check_positive_int(limit, "LIMIT must be an integer of value 1 or greater.")
 
@@ -343,13 +343,13 @@ def check_timeout(timeout: str) -> int:
         timeout : str
             The timeout to be validated.
 
-    Raises
-    ------
-        argparse.ArgumentTypeError
-
     Returns
     -------
         int : the validated timeout.
+
+    Raises
+    ------
+        argparse.ArgumentTypeError
     """
     return check_positive_int(
         timeout, "timeout must be an integer of value 1 or greater."

diff --git a/src/scribe_data/utils.py b/src/scribe_data/utils.py
@@ -102,13 +102,13 @@ def _find(source_key: str, source_value: str, target_key: str, error_msg: str):
         error_msg : str
             The message displayed when a value cannot be found.
 
-    Raises
-    ------
-        ValueError : when a source_value is not supported.
-
     Returns
     -------
         The 'target' value given the passed arguments.
+
+    Raises
+    ------
+        ValueError : when a source_value is not supported.
     """
     norm_source_value = source_value.lower()