Update docs - API

mikelkou · Aug 18, 2023 · 86f8ef2 · 86f8ef2
1 parent b7d9407
commit 86f8ef2
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/docs/source/API.rst b/docs/source/API.rst
@@ -1,7 +1,9 @@
 API
 =====
 
-.. automodule:: fava.cook
+This section provides documentation for the `fava.py` module.
+
+.. automodule:: fava
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -4,11 +4,14 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
+import os
 import sys
 from pathlib import Path
 
 HERE = Path(__file__).parent
 sys.path.insert(0, str(HERE / "extensions"))
+# Add the path to the directory containing fava.py to the Python path
+sys.path.insert(0, os.path.abspath("../../src/favapy"))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,8 +8,8 @@ Welcome to favapy’s documentation!
    Installation
    Using_FAVA_as_a_Python_library
    Command_Line_Interface
-   Tutorials
    API
+   Tutorials
 
 Introduction
 -------------