Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ConsPortfolioModel Does Not Appear In Sphinx Docs Yet #468

Closed
llorracc opened this issue Jan 7, 2020 · 2 comments
Closed

ConsPortfolioModel Does Not Appear In Sphinx Docs Yet #468

llorracc opened this issue Jan 7, 2020 · 2 comments
Assignees

Comments

@llorracc
Copy link
Collaborator

llorracc commented Jan 7, 2020

I thought that Sphinx was supposed to automatically pick up new content as long as we included docstrings, etc. But it does not seem to be there when I search for PortfolioConsumerType in hark.readthedocs.io ...

@project-bot project-bot bot added this to Needs Triage in Issues & PRs Jan 7, 2020
@sbenthall sbenthall self-assigned this Jan 8, 2020
@sbenthall
Copy link
Contributor

Sphinx configuration is done by the .rst files here:
https://github.com/econ-ark/HARK/tree/master/Documentation

Specifically, the API docs are configured here:
https://github.com/econ-ark/HARK/blob/master/Documentation/api.rst

It's a good point that the Sphinx docs should be updated to include the HARK library files, as they are the API.

@llorracc
Copy link
Collaborator Author

llorracc commented Jan 8, 2020 via email

Issues & PRs automation moved this from Needs Triage to Done Feb 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Issues & PRs
  
Done
Development

No branches or pull requests

2 participants