Add autosummary to model docs

iiasa · Apr 30, 2020 · 0673fb3 · 0673fb3
1 parent 2a1bc18
commit 0673fb3
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -82,8 +82,14 @@ Model classes
 
 .. currentmodule:: message_ix.models
 
-.. automodule:: message_ix.models
-   :exclude-members: MESSAGE, MESSAGE_MACRO
+.. autosummary::
+
+   MESSAGE
+   MACRO
+   MESSAGE_MACRO
+   GAMSModel
+   DEFAULT_CPLEX_OPTIONS
+   MESSAGE_ITEMS
 
 .. autodata:: DEFAULT_CPLEX_OPTIONS
 
@@ -125,6 +131,8 @@ Model classes
       **var_list**       :obj:`None`
       ================== ===
 
+.. autoclass:: MACRO
+
 .. autoclass:: MESSAGE_MACRO
    :members:
    :show-inheritance:

diff --git a/message_ix/models.py b/message_ix/models.py
@@ -154,10 +154,12 @@ def run(self, scenario):
 
 
 class MESSAGE(GAMSModel):
+    """Model class for MESSAGE."""
     name = 'MESSAGE'
 
 
 class MACRO(GAMSModel):
+    """Model class for MACRO."""
     name = 'MACRO'
 
     #: MACRO uses the GAMS ``break;`` statement, and thus requires GAMS 24.8.1
@@ -191,6 +193,7 @@ def initialize(cls, scenario, with_data=False):
 
 
 class MESSAGE_MACRO(MACRO):
+    """Model class for MESSAGE_MACRO."""
     name = 'MESSAGE-MACRO'
 
     def __init__(self, *args, **kwargs):