Fix doc build

CURENT · Nov 14, 2024 · 4b8fde1 · 4b8fde1
1 parent a640d5a
commit 4b8fde1
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 16 deletions.
diff --git a/ams/routines/dcopf.py b/ams/routines/dcopf.py
@@ -234,7 +234,7 @@ def __init__(self, system, config):
     def solve(self, **kwargs):
         """
         Solve the routine optimization model.
-        *args and **kwargs go to `self.om.prob.solve()` (`cvxpy.Problem.solve()`).
+        args and kwargs go to `self.om.prob.solve()` (`cvxpy.Problem.solve()`).
         """
         return self.om.prob.solve(**kwargs)
 

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -44,6 +44,8 @@ Routines
    :template: autosummary/module_toctree.rst
 
    ams.routines.routine
+   ams.routines.dcopf
+   ams.routines.pflow
 
 
 Optimization
@@ -56,7 +58,7 @@ Optimization
    :caption: Optimization
    :template: autosummary/module_toctree.rst
 
-   ams.opt.omodel
+   ams.opt
 
 
 I/O
@@ -82,7 +84,7 @@ Interoperability
    :caption: Interoperability
    :template: autosummary/module_toctree.rst
 
-   ams.interop
+   ams.interface
 
 
 Others

diff --git a/docs/source/getting_started/install.rst b/docs/source/getting_started/install.rst
@@ -172,8 +172,8 @@ Note the dot at the end. Pip will take care of the rest.
 .. note::
 
     To install extra support packages, one can append ``[NAME_OF_EXTRA]`` to
-    ``pip install -e .``. For example, ``pip install -e .[interop]`` will
-    install packages to support interoperability when installing AMS in the
+    ``pip install -e .``. For example, ``pip install -e .[doc]`` will
+    install packages to support documentation when installing AMS in the
     development, editable mode.
 
 Updating AMS

diff --git a/docs/source/modeling/routine.rst b/docs/source/modeling/routine.rst
@@ -58,13 +58,6 @@ Further, to facilitate the routine definition, AMS developed a class
 .. autoclass:: ams.core.param.RParam
     :noindex:
 
-.. currentmodule:: ams.routines
-.. autosummary::
-      :recursive:
-      :toctree: _generated
-
-      RoutineBase
-
 Numerical Optimization
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -87,7 +80,7 @@ Interoperation with ANDES
 -----------------------------------
 
 The interoperation with dynamic simulator invovles both file conversion and data exchange.
-In AMS, the built-in interface with ANDES is implemented in :py:mod:`ams.interop.andes`.
+In AMS, the built-in interface with ANDES is implemented in :py:mod:`ams.interface`.
 
 
 File Format Converter
@@ -98,7 +91,7 @@ where it defines grid topology and power flow.
 An AMS case can be converted to an ANDES case, with the option to supply additional dynamic
 data.
 
-.. autofunction:: ams.interop.andes.to_andes
+.. autofunction:: ams.interface.to_andes
     :noindex:
 
 
@@ -112,10 +105,10 @@ The maping relationship for a specific routine is defined in the routine class a
 ``map2``.
 Additionally, a link table for the ANDES case is used for the controller connections.
 
-Module :py:mod:`ams.interop.andes.Dynamic`, contains the necessary functions and classes for
+Module :py:mod:`ams.interface.Dynamic`, contains the necessary functions and classes for
 file conversion and data exchange.
 
-.. autoclass:: ams.interop.andes.Dynamic
+.. autoclass:: ams.interface.Dynamic
     :noindex:
     :members: send, receive