setup autodoc

lanl · Dec 18, 2024 · 4588a11 · 4588a11
1 parent f5c3d8d
commit 4588a11
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -13,8 +13,17 @@
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+import os
+import sys
+import hydropop
+sys.path.insert(0, os.path.abspath("../"))
 
-extensions = []
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary"]
+
+autosummary_generate = True
+autodoc_member_order = "bysource"
+# Remove parentheses from functions cross-referenced
+add_function_parentheses = False
 
 templates_path = ["_templates"]
 exclude_patterns = []

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,6 +11,7 @@ Welcome to hpdocs's documentation!
    pages/installation
    pages/hpdata
    pages/terminology
+   pages/api
 
 
 .. Indices and tables

diff --git a/docs/source/pages/api.rst b/docs/source/pages/api.rst
@@ -0,0 +1,10 @@
+.. currentmodule:: hydropop
+
+API
+===
+
+hp_utils
+----------------------------
+
+.. automodule:: hydropop.hp_utils
+   :members: