docs: Update Read the Docs

phumthep · phumthep · commit 92ca1ef0875a · 2025-05-19T16:17:19.000-04:00
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,7 +1,8 @@
 sphinx >= 8.1.0
 sphinx-rtd-theme >= 3.0.2
+sphinx-mdinclude >= 0.6.2
 nbsphinx >= 0.9.7
 nbsphinx_link >= 1.3.1
 sphinxcontrib-bibtex >= 2.6.3
 sphinx_autodoc_typehints
-ipykernel
+ipykernel
diff --git a/docs/source/api_ref/api.rst b/docs/source/api_ref/api.rst
diff --git a/docs/source/api_ref/modules.rst b/docs/source/api_ref/modules.rst
diff --git a/docs/source/api_ref/pownet.core.rst b/docs/source/api_ref/pownet.core.rst
@@ -4,18 +4,18 @@ pownet.core package
 Submodules
 ----------
 
-pownet.core.model_builder module
---------------------------
+pownet.core.data\_processor module
+----------------------------------
 
-.. automodule:: pownet.core.model_builder
+.. automodule:: pownet.core.data_processor
    :members:
    :undoc-members:
    :show-inheritance:
 
-pownet.core.data\_processor module
-----------------------------------
+pownet.core.model\_builder module
+---------------------------------
 
-.. automodule:: pownet.core.data_processor
+.. automodule:: pownet.core.model_builder
    :members:
    :undoc-members:
    :show-inheritance:
@@ -59,11 +59,3 @@ pownet.core.visualizer module
    :members:
    :undoc-members:
    :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: pownet.core
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/api_ref/pownet.data_model.rst b/docs/source/api_ref/pownet.data_model.rst
@@ -1,21 +1,9 @@
 pownet.data\_model package
 ==========================
 
-Submodules
-----------
-
 pownet.data\_model.reservoir module
 -----------------------------------
 
 .. automodule:: pownet.data_model.reservoir
    :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: pownet.data_model
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   :no-index:
diff --git a/docs/source/api_ref/pownet.optim_model.rst b/docs/source/api_ref/pownet.optim_model.rst
@@ -36,8 +36,8 @@ pownet.optim\_model.rounding\_algo module
    :undoc-members:
    :show-inheritance:
 
-pownet.optim\_model.variable_func module
------------------------------------
+pownet.optim\_model.variable\_func module
+-----------------------------------------
 
 .. automodule:: pownet.optim_model.variable_func
    :members:
diff --git a/docs/source/api_ref/pownet.rst b/docs/source/api_ref/pownet.rst
@@ -1,20 +1,22 @@
-pownet package
+API Reference
 ==============
 
-Subpackages
------------
+pownet.core module
+---------------------
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 0
 
    pownet.core
    pownet.data_model
    pownet.optim_model
    pownet.reservoir
    pownet.stochastic
 
-Submodules
-----------
+.. automodule:: pownet.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 pownet.coupler module
 ---------------------
@@ -47,11 +49,3 @@ pownet.input module
    :members:
    :undoc-members:
    :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: pownet
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -8,18 +8,25 @@
 # Import mock modules for readthedocs
 autodoc_mock_imports = [
     "__future__",
+    "abc",
+    "dataclasses",
     "datetime",
     "re",
     "contextily",
     "geopandas",
     "gurobipy",
     "highspy",
-    "networkx",
+    "logging",
     "matplotlib",
     "math",
+    "networkx",
     "numpy",
     "pandas",
+    "pmdarima",
+    "scipy",
     "shapely",
+    "sklearn",
+    "statsmodels",
 ]
 
 # -- Project information
@@ -45,6 +52,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx_rtd_theme",
+    "sphinx_mdinclude",
     "nbsphinx",
     "nbsphinx_link",
     "sphinx_autodoc_typehints",
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -74,19 +74,21 @@ School of Civil and Environmental Engineering, Cornell University.
 
 **References**
 
+* :doc:`reference/contributing`
 * :doc:`reference/cite_pownet`
 * :doc:`reference/publications`
 * :doc:`reference/developers`
 * :doc:`reference/glossary`
-* :doc:`api_ref/api`
+* :doc:`api_ref/pownet`
 
 .. toctree::
    :hidden:
    :caption: References
    :maxdepth: 0
 
+   reference/contributing
    reference/cite_pownet
    reference/publications
    reference/developers
    reference/glossary
-   api_ref/api
+   api_ref/pownet
diff --git a/docs/source/reference/contributing.rst b/docs/source/reference/contributing.rst
@@ -0,0 +1,10 @@
+
+.. autosummary::
+    :toctree: _source/
+
+################################
+Contributing
+################################
+
+    
+.. mdinclude:: ../../.github/CONTRIBUTING.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,7 +14,7 @@ source = ["pownet"]
 
 [project]
 name = "pownet"
-version = "2.2.0"
+version = "2.3.0"
 description = "A simple production cost model of framework for power systems"
 readme = "README.md"
 authors = [{ name = "Phumthep Bunnak", email = "pb585@cornell.edu" }]
diff --git a/src/pownet/builder/__init__.py b/src/pownet/builder/__init__.py
@@ -0,0 +1 @@
+"""This is the builder module."""
diff --git a/src/pownet/data_model/reservoir.py b/src/pownet/data_model/reservoir.py
@@ -1,3 +1,5 @@
+"""reservoir.py"""
+
 import dataclasses
 import math
 
@@ -20,12 +22,10 @@ class ReservoirParams:
         max_release (float): The maximum allowable daily release rate (m³/day).
         max_generation (float): The maximum power generation capacity (MW).
         turbine_factor (float): The efficiency factor of the turbine(s).
-        inflow_ts (pd.Series): Timeseries of daily natural inflow into the reservoir (m³/day),
-                            indexed from 1.
+        inflow_ts (pd.Series): Timeseries of daily natural inflow into the reservoir (m³/day), indexed from 1.
         minflow_ts (pd.Series): Minimum environmental flow (m³/day), indexed from 1.
         upstream_units (list[str]): List of upstream reservoir names that feed into this reservoir.
-        downstream_flow_fracs (dict[str, float]): Dictionary mapping downstream reservoir names to their
-                                                respective flow fractions (0-1).
+        downstream_flow_fracs (dict[str, float]): Dictionary mapping downstream reservoir names to their respective flow fractions (0-1).
     """
 
     name: str
diff --git a/src/pownet/optim_model/constraints/system_constr.py b/src/pownet/optim_model/constraints/system_constr.py
@@ -177,8 +177,7 @@ def add_c_flow_balance(
 
     The balance considers:
     - Power generated at the node (adjusted for generation efficiency).
-    - Power flow into and out of the node via transmission lines (adjusted
-      for line losses).
+    - Power flow into and out of the node via transmission lines (adjusted for line losses).
     - Power consumed by energy storage charging at the node.
     - Power injected by energy storage discharging at the node.
     - Power demand at the node.
diff --git a/src/pownet/stochastic/__init__.py b/src/pownet/stochastic/__init__.py
@@ -1,5 +1,4 @@
-""" stochastic_data module.
-"""
+"""stochastic module."""
 
 from .timeseries_model import TimeSeriesModel
 from .demand import DemandTSModel
