adding ConsumptionSaving to the docs

[sbenthall]

This PR addresses #468

[MridulS]

Should we have just HARK.ConsumptionSaving on the home page instead of all the models?

[llorracc]

If there's a natural way to do that, yes, it would be better to just have HARK.ConsumptionSaving there -- IF the contents of each of the models will get indexed by Sphinx? Eventually we would want to do the same with, say, HARK.FirmInvestment when we have that set of models fleshed out.

…

On Wed, Jan 8, 2020 at 7:33 AM Mridul Seth ***@***.***> wrote: ***@***.**** commented on this pull request. Should we have just HARK.ConsumptionSaving on the home page instead of all the models? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#469?email_source=notifications&email_token=AAKCK73EBECKDCBK6QRFP33Q4XBY5A5CNFSM4KEBIKS2YY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCRAXIGI#pullrequestreview-339833881>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKCK74NE3WFFZ2BRKFBBL3Q4XBY5ANCNFSM4KEBIKSQ> .

-- - Chris Carroll

[sbenthall]

I'm not sure how to do this cleanly.
I can try to figure it out. Do you know how, @MridulS ?

[sbenthall]

Maybe we can do it like QuantEcon does it?
https://quanteconpy.readthedocs.io/en/latest/optimize/root_finding.html
https://github.com/QuantEcon/QuantEcon.py/tree/master/docs/source

[sbenthall]

I've played around with this some.
Most recent commit reflects my best sense of how to do this.

The autosummary feature of Sphinx takes a lot of control over the creation of the docs.
It looks like it winds up creating javascript that overwrites the markup of the api.rst file, which makes it difficult to configure around.

It looks like most other projects use a more hands-on approach to configuring their documentation.

What about splitting up the docs into 'Tools' and 'Models'?

In the current PR, no individual classes are listed on the documentation home page.

[sbenthall]

As of the most recent commit:

• All the tools are listed individually in the TOC sidebar, which links to their own pages with module definition.
• HARK.ConsumptionSaving appears in the sidebar; its page documents all of its submodules.

Requesting review.

[sbenthall]

This new commit gets things to how we discussed in the last meeting:

• the HARK.ConsumptionSaving page now has a list of its submodules
• each of the submodules has its own page, with expanded documentation
• those pages appear in the side-bar/TOC in a sensible way.

2782380

Requesting review from @MridulS

[sbenthall]

You can see how this works on my fork's RTD's now:
https://hark-sb.readthedocs.io/en/i468/api-consumptionsaving.html

[sbenthall]

It looks like there's something wrong with the status checks after the recent merge from master.

The GitHub actions tests have all passed.
But it looks like the Travis CI build has hung for 11 hours.

[MridulS]

all good now, Travis just needed a little bit of nudge to rebuild it.

[sbenthall]

look ok to merge?

[MridulS]

+1