From 57bab05764725254a9b21d3ff493f6011b4739bb Mon Sep 17 00:00:00 2001 From: sb Date: Tue, 7 Jan 2020 20:05:33 -0500 Subject: [PATCH 1/5] adding ConsPortfolioModel to the docs --- Documentation/api.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/api.rst b/Documentation/api.rst index 0c7113c05..650183259 100644 --- a/Documentation/api.rst +++ b/Documentation/api.rst @@ -12,3 +12,4 @@ API Documentation HARK.simulation HARK.utilities HARK.validators + HARK.ConsumptionSaving.ConsPortfolioModel From 82d0c8f229d7908b078468ad54b1f43b6b7663f0 Mon Sep 17 00:00:00 2001 From: sb Date: Tue, 7 Jan 2020 20:17:18 -0500 Subject: [PATCH 2/5] putting the rest of ConsumptionSaving into the docs --- Documentation/api.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Documentation/api.rst b/Documentation/api.rst index 650183259..fdc634486 100644 --- a/Documentation/api.rst +++ b/Documentation/api.rst @@ -12,4 +12,13 @@ API Documentation HARK.simulation HARK.utilities HARK.validators + HARK.ConsumptionSaving.ConsAggShockModel + HARK.ConsumptionSaving.ConsGenIncProcessModel + HARK.ConsumptionSaving.ConsIndShockModel + HARK.ConsumptionSaving.ConsMarkovModel + HARK.ConsumptionSaving.ConsMedModel HARK.ConsumptionSaving.ConsPortfolioModel + HARK.ConsumptionSaving.ConsPrefShockModel + HARK.ConsumptionSaving.ConsRepAgentModel + HARK.ConsumptionSaving.TractableBufferStockModel + From b713c8a7d79321fce5bb3bcd85fd60c433b71818 Mon Sep 17 00:00:00 2001 From: sb Date: Wed, 8 Jan 2020 15:36:13 -0500 Subject: [PATCH 3/5] Moving ConsumptionSaving files off the home page--broader Tools/ConsumptionSaving reorg... --- Documentation/api.rst | 75 +++++++++++++++++++++++++++++++------------ 1 file changed, 55 insertions(+), 20 deletions(-) diff --git a/Documentation/api.rst b/Documentation/api.rst index fdc634486..afaedfff7 100644 --- a/Documentation/api.rst +++ b/Documentation/api.rst @@ -1,24 +1,59 @@ API Documentation ================== -.. autosummary:: - :toctree: generated - - HARK.core - HARK.dcegm - HARK.estimation - HARK.interpolation - HARK.parallel - HARK.simulation - HARK.utilities - HARK.validators - HARK.ConsumptionSaving.ConsAggShockModel - HARK.ConsumptionSaving.ConsGenIncProcessModel - HARK.ConsumptionSaving.ConsIndShockModel - HARK.ConsumptionSaving.ConsMarkovModel - HARK.ConsumptionSaving.ConsMedModel - HARK.ConsumptionSaving.ConsPortfolioModel - HARK.ConsumptionSaving.ConsPrefShockModel - HARK.ConsumptionSaving.ConsRepAgentModel - HARK.ConsumptionSaving.TractableBufferStockModel +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: From afb56bbe66b19939e8a8c2e709c28bc45da6190f Mon Sep 17 00:00:00 2001 From: sb Date: Mon, 13 Jan 2020 16:27:16 -0500 Subject: [PATCH 4/5] Tools on the home page of the docs, ConsumptionSaving modules all on their own page --- Documentation/api-consumptionsaving.rst | 29 +++++++++++++++++++++++++ Documentation/api-core.rst | 5 +++++ Documentation/api-dcegm.rst | 5 +++++ Documentation/api-estimation.rst | 5 +++++ Documentation/api-interpolation.rst | 5 +++++ Documentation/api-parallel.rst | 5 +++++ Documentation/api-simulation.rst | 5 +++++ Documentation/api-utilities.rst | 6 +++++ Documentation/api-validators.rst | 5 +++++ Documentation/index.rst | 12 +++++++++- 10 files changed, 81 insertions(+), 1 deletion(-) create mode 100644 Documentation/api-consumptionsaving.rst create mode 100644 Documentation/api-core.rst create mode 100644 Documentation/api-dcegm.rst create mode 100644 Documentation/api-estimation.rst create mode 100644 Documentation/api-interpolation.rst create mode 100644 Documentation/api-parallel.rst create mode 100644 Documentation/api-simulation.rst create mode 100644 Documentation/api-utilities.rst create mode 100644 Documentation/api-validators.rst diff --git a/Documentation/api-consumptionsaving.rst b/Documentation/api-consumptionsaving.rst new file mode 100644 index 000000000..c980a70dc --- /dev/null +++ b/Documentation/api-consumptionsaving.rst @@ -0,0 +1,29 @@ +HARK.ConsumptionSaving +=================== + +.. 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/api-core.rst b/Documentation/api-core.rst new file mode 100644 index 000000000..36a718efc --- /dev/null +++ b/Documentation/api-core.rst @@ -0,0 +1,5 @@ +HARK.core +========= + +.. automodule:: HARK.core + :members: diff --git a/Documentation/api-dcegm.rst b/Documentation/api-dcegm.rst new file mode 100644 index 000000000..81260ff36 --- /dev/null +++ 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 new file mode 100644 index 000000000..637677c6d --- /dev/null +++ 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 new file mode 100644 index 000000000..484cd0c91 --- /dev/null +++ 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 new file mode 100644 index 000000000..f7656730c --- /dev/null +++ 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 new file mode 100644 index 000000000..676919926 --- /dev/null +++ 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 new file mode 100644 index 000000000..da26dfe59 --- /dev/null +++ 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 new file mode 100644 index 000000000..10905e44b --- /dev/null +++ b/Documentation/api-validators.rst @@ -0,0 +1,5 @@ +HARK.validators +=============== + +.. automodule:: HARK.validators + :members: diff --git a/Documentation/index.rst b/Documentation/index.rst index 12935f8d2..9ca2810b6 100644 --- 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 ================== From 2782380e96b8d20262f4932de43d755bfab98948 Mon Sep 17 00:00:00 2001 From: sb Date: Thu, 16 Jan 2020 16:25:59 -0500 Subject: [PATCH 5/5] separate module pages for ConsumptionSaving classes --- Documentation/api-consumptionsaving.rst | 35 ++++++------------- Documentation/api-cs-ConsAggShockModel.rst | 6 ++++ .../api-cs-ConsGenIncProcessModel.rst | 5 +++ Documentation/api-cs-ConsIndShockModel.rst | 7 ++++ Documentation/api-cs-ConsMarkovModel.rst | 5 +++ Documentation/api-cs-ConsMedModel.rst | 5 +++ Documentation/api-cs-ConsPortfolioModel.rst | 5 +++ Documentation/api-cs-ConsPrefShockModel.rst | 6 ++++ Documentation/api-cs-ConsRepAgentModel.rst | 6 ++++ .../api-cs-TractableBufferStockModel.rst | 5 +++ 10 files changed, 60 insertions(+), 25 deletions(-) create mode 100644 Documentation/api-cs-ConsAggShockModel.rst create mode 100644 Documentation/api-cs-ConsGenIncProcessModel.rst create mode 100644 Documentation/api-cs-ConsIndShockModel.rst create mode 100644 Documentation/api-cs-ConsMarkovModel.rst create mode 100644 Documentation/api-cs-ConsMedModel.rst create mode 100644 Documentation/api-cs-ConsPortfolioModel.rst create mode 100644 Documentation/api-cs-ConsPrefShockModel.rst create mode 100644 Documentation/api-cs-ConsRepAgentModel.rst create mode 100644 Documentation/api-cs-TractableBufferStockModel.rst diff --git a/Documentation/api-consumptionsaving.rst b/Documentation/api-consumptionsaving.rst index c980a70dc..275e9a906 100644 --- a/Documentation/api-consumptionsaving.rst +++ b/Documentation/api-consumptionsaving.rst @@ -1,29 +1,14 @@ HARK.ConsumptionSaving =================== -.. 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: +.. toctree:: + :maxdepth: 2 -.. automodule:: HARK.ConsumptionSaving.ConsPrefShockModel - :members: - -.. automodule:: HARK.ConsumptionSaving.ConsRepAgentModel - :members: - -.. automodule:: HARK.ConsumptionSaving.TractableBufferStockModel - :members: + 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-cs-ConsAggShockModel.rst b/Documentation/api-cs-ConsAggShockModel.rst new file mode 100644 index 000000000..48fc6c99e --- /dev/null +++ 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 new file mode 100644 index 000000000..9bb4d1334 --- /dev/null +++ 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 new file mode 100644 index 000000000..6b9ec13ad --- /dev/null +++ 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 new file mode 100644 index 000000000..eb904daa6 --- /dev/null +++ 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 new file mode 100644 index 000000000..e2aff86cc --- /dev/null +++ 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 new file mode 100644 index 000000000..b4fd0482e --- /dev/null +++ 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 new file mode 100644 index 000000000..c0a6acd13 --- /dev/null +++ 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 new file mode 100644 index 000000000..fba7e08b9 --- /dev/null +++ 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 new file mode 100644 index 000000000..984651786 --- /dev/null +++ b/Documentation/api-cs-TractableBufferStockModel.rst @@ -0,0 +1,5 @@ +HARK.ConsumptionSaving.TractableBufferStockModel +================================================ + +.. automodule:: HARK.ConsumptionSaving.TractableBufferStockModel + :members: