adding ConsumptionSaving to the docs (#469)

* adding ConsPortfolioModel to the docs * putting the rest of ConsumptionSaving into the docs * Moving ConsumptionSaving files off the home page--broader Tools/ConsumptionSaving reorg... * Tools on the home page of the docs, ConsumptionSaving modules all on their own page * separate module pages for ConsumptionSaving classes Co-authored-by: Mridul Seth <[email protected]> Co-authored-by: Christopher Llorracc Carroll <[email protected]>
econ-ark · Feb 1, 2020 · c22ce40 · c22ce40
1 parent 46d747a
commit c22ce40
Show file tree

Hide file tree

Showing 20 changed files with 172 additions and 12 deletions.
diff --git a/Documentation/api-consumptionsaving.rst b/Documentation/api-consumptionsaving.rst
@@ -0,0 +1,14 @@
+HARK.ConsumptionSaving
+===================
+
+.. toctree::
+   :maxdepth: 2
+
+   api-cs-ConsAggShockModel
+   api-cs-ConsGenIncProcessModel
+   api-cs-ConsIndShockModel
+   api-cs-ConsMarkovModel
+   api-cs-ConsPortfolioModel           
+   api-cs-ConsPrefShochModel
+   api-cs-ConsRepAgentModel
+   api-cs-TractableBufferStockModel           
diff --git a/Documentation/api-core.rst b/Documentation/api-core.rst
@@ -0,0 +1,5 @@
+HARK.core
+=========
+
+.. automodule:: HARK.core
+   :members:
diff --git a/Documentation/api-cs-ConsAggShockModel.rst b/Documentation/api-cs-ConsAggShockModel.rst
@@ -0,0 +1,6 @@
+HARK.ConsumptionSaving.ConsAggShockModel
+========================================
+
+.. automodule:: HARK.ConsumptionSaving.ConsAggShockModel
+   :members:
+
diff --git a/Documentation/api-cs-ConsGenIncProcessModel.rst b/Documentation/api-cs-ConsGenIncProcessModel.rst
@@ -0,0 +1,5 @@
+HARK.ConsumptionSaving.ConsGenIncProcessModel
+================================================
+
+.. automodule:: HARK.ConsumptionSaving.ConsGenIncProcessModel 
+   :members:
diff --git a/Documentation/api-cs-ConsIndShockModel.rst b/Documentation/api-cs-ConsIndShockModel.rst
@@ -0,0 +1,7 @@
+HARK.ConsumptionSaving.ConsIndShockModel
+========================================
+
+.. automodule:: HARK.ConsumptionSaving.ConsIndShockModel
+   :members:
+
+
diff --git a/Documentation/api-cs-ConsMarkovModel.rst b/Documentation/api-cs-ConsMarkovModel.rst
@@ -0,0 +1,5 @@
+HARK.ConsumptionSaving.ConsMarkovModel
+======================================
+
+.. automodule:: HARK.ConsumptionSaving.ConsMarkovModel
+   :members:
diff --git a/Documentation/api-cs-ConsMedModel.rst b/Documentation/api-cs-ConsMedModel.rst
@@ -0,0 +1,5 @@
+HARK.ConsumptionSaving.ConsMedModel
+=====================================
+
+.. automodule:: HARK.ConsumptionSaving.ConsMedModel
+   :members:
diff --git a/Documentation/api-cs-ConsPortfolioModel.rst b/Documentation/api-cs-ConsPortfolioModel.rst
@@ -0,0 +1,5 @@
+HARK.ConsumptionSaving.ConsPortfolioModel
+=========================================
+
+.. automodule:: HARK.ConsumptionSaving.ConsPortfolioModel
+   :members:
diff --git a/Documentation/api-cs-ConsPrefShockModel.rst b/Documentation/api-cs-ConsPrefShockModel.rst
@@ -0,0 +1,6 @@
+HARK.ConsumptionSaving.ConsPrefShockModel
+=========================================
+
+.. automodule:: HARK.ConsumptionSaving.ConsPrefShockModel
+   :members:
+
diff --git a/Documentation/api-cs-ConsRepAgentModel.rst b/Documentation/api-cs-ConsRepAgentModel.rst
@@ -0,0 +1,6 @@
+HARK.ConsumptionSaving.ConsRepAgentModel
+========================================
+
+.. automodule:: HARK.ConsumptionSaving.ConsRepAgentModel
+   :members:
+
diff --git a/Documentation/api-cs-TractableBufferStockModel.rst b/Documentation/api-cs-TractableBufferStockModel.rst
@@ -0,0 +1,5 @@
+HARK.ConsumptionSaving.TractableBufferStockModel
+================================================
+
+.. automodule:: HARK.ConsumptionSaving.TractableBufferStockModel
+   :members:
diff --git a/Documentation/api-dcegm.rst b/Documentation/api-dcegm.rst
@@ -0,0 +1,5 @@
+HARK.dcegm
+===========
+
+.. automodule:: HARK.dcegm
+   :members:
diff --git a/Documentation/api-estimation.rst b/Documentation/api-estimation.rst
@@ -0,0 +1,5 @@
+HARK.estimation
+=================
+
+.. automodule:: HARK.estimation
+   :members:
diff --git a/Documentation/api-interpolation.rst b/Documentation/api-interpolation.rst
@@ -0,0 +1,5 @@
+HARK.interpolation
+=====================
+
+.. automodule:: HARK.interpolation
+   :members:
diff --git a/Documentation/api-parallel.rst b/Documentation/api-parallel.rst
@@ -0,0 +1,5 @@
+HARK.parallel
+==============
+
+.. automodule:: HARK.parallel
+   :members:
diff --git a/Documentation/api-simulation.rst b/Documentation/api-simulation.rst
@@ -0,0 +1,5 @@
+HARK.simulation
+================
+
+.. automodule:: HARK.simulation
+   :members:
diff --git a/Documentation/api-utilities.rst b/Documentation/api-utilities.rst
@@ -0,0 +1,6 @@
+HARK.utilities
+================
+
+.. automodule:: HARK.utilities
+   :members:
+
diff --git a/Documentation/api-validators.rst b/Documentation/api-validators.rst
@@ -0,0 +1,5 @@
+HARK.validators
+===============
+
+.. automodule:: HARK.validators
+   :members:
diff --git a/Documentation/api.rst b/Documentation/api.rst
@@ -1,14 +1,59 @@
 API Documentation
 ==================
 
-.. autosummary::
-   :toctree: generated
-
-   HARK.core
-   HARK.dcegm
-   HARK.estimation
-   HARK.interpolation
-   HARK.parallel
-   HARK.simulation
-   HARK.utilities
-   HARK.validators
+Tools
+-----------
+
+.. automodule:: HARK.core
+   :members:
+
+.. automodule:: HARK.dcegm
+   :members:
+
+.. automodule:: HARK.estimation
+   :members:
+
+.. automodule:: HARK.interpolation
+   :members:
+
+.. automodule:: HARK.parallel
+   :members:
+
+.. automodule:: HARK.simulation
+   :members:
+
+.. automodule:: HARK.utilities
+   :members:
+
+.. automodule:: HARK.validators
+   :members:
+
+Consumption Saving
+--------------------
+
+.. automodule:: HARK.ConsumptionSaving.ConsAggShockModel
+   :members:
+
+.. automodule:: HARK.ConsumptionSaving.ConsGenIncProcessModel 
+   :members:
+
+.. automodule:: HARK.ConsumptionSaving.ConsIndShockModel
+   :members:
+
+.. automodule:: HARK.ConsumptionSaving.ConsMarkovModel
+   :members:
+
+.. automodule:: HARK.ConsumptionSaving.ConsMedModel
+   :members:
+
+.. automodule:: HARK.ConsumptionSaving.ConsPortfolioModel
+   :members:
+
+.. automodule:: HARK.ConsumptionSaving.ConsPrefShockModel
+   :members:
+
+.. automodule:: HARK.ConsumptionSaving.ConsRepAgentModel
+   :members:
+
+.. automodule:: HARK.ConsumptionSaving.TractableBufferStockModel
+   :members:
diff --git a/Documentation/index.rst b/Documentation/index.rst
@@ -35,7 +35,17 @@ you might want to look at the `DemARK
    :maxdepth: 2
    :caption: Python API
 
-   api
+   api-core
+   api-dcegm
+   api-estimation
+   api-interpolation
+   api-parallel
+   api-simulation
+   api-utilities
+   api-validators          
+   api-consumptionsaving
+
+
 
 Indices and tables
 ==================