-
-
Notifications
You must be signed in to change notification settings - Fork 199
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
Update docs to work with Read the Docs #353
Conversation
This is a very good start. Something that should be an easy improvement is that wherever readthedocs content is generated from a notebook, there should be an explicit link to a mybinder instantiation of the notebook, so that the user can view a live, interactive version of it as an alternative to the static rst rendering. Another easy improvement is that it would be good to have at least a couple of subcategories under "Notebooks":
(I will put together a list of the notebooks in each of these categories to be included for now) The thing I would be happiest to have would be some mechanism by which it was possible for the Sphinx index to know about and link to examples of the use of the a particular tool in a designated collection of notebooks. For example, if we include the The rendering of the notebooks, because it is something we have not tried before, has some problems. I'm guessing that these will need to be fixed by changing the notebook source, because whatever tool is being used to translate the notebook to rst is probably not something we can modify in ways that will fix the problems. (But, @ericholscher, could you provide a link to some documentation on the tool? Is it basically just a script that invokes Examples:
|
I'd like to merge this today but there's a merge conflict. Could you resolve this and let me know when it is ready? (Not sure what went wrong -- definitely the DCT-Copula-Illustration-OneAsset.py file should not be changed by this merge, so if you can replace with the master version we should be set). |
@llorracc I ran into this issue with a unicode character in the file while doing my testing: https://github.com/econ-ark/HARK/pull/353/files#diff-4af1295874e1dbe074f2688dc724e3c7L310 -- is that meant to be there? I can revert my change if so, but it didn't seem like valid Python to me. |
Looks like it was deleted in |
Release notes: Moved documentation to ReadTheDocs and Sphinx |
Just noticed that our README.md still pointed to the old version of the docs. Fixed to point to draft new version. |
I've just updated the README to point to
https://hark.readthedocs.io/en/eh-sphinx-updates/# but my sense is that the
final link will be different (in particular, probably will not have the
eh-sphinx-updates/# part?) If these notes have not been transferred over
to their permanent location, I'd like to do that ASAP (and then change the
README.md to point to the permanent location).
…On Fri, Jul 19, 2019 at 4:36 PM Eric Holscher ***@***.***> wrote:
Looks like it was deleted in master, so I have removed my changes in this
branch.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#353?email_source=notifications&email_token=AAKCK757IXJ63LCF4USIUB3QAHGQLA5CNFSM4ID32HTKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD2L2FMY#issuecomment-513254067>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAKCK7YBFQDTUQYCSUJRJ4TQAHGQLANCNFSM4ID32HTA>
.
--
- Chris Carroll
|
Jan Rosa has been working with me to improve the HARK documentation, and I've had him look in particular for toolkits that do a good job of guiding new users into the substance of the toolkit, by constructing curated "journeys into HARK" for people with different backgrounds. He's found some nice examples and what I would like to have him do is to create the rudiments of at least two different "journeys into HARK" -- one from the perspective of a first year PhD economics grad student, and one for someone with a lot of computer expertise but less economics grounding. I'm sending this message because if the two of you have advice for him (esp about integration of such journeys into RTD), that would be useful to him. |
[There is a bit more background here in an email between myself & Christopher, Shauna, and Sam]
I have a branch of this building here for you to preview:
https://hark.readthedocs.io/en/eh-sphinx-updates/
It currently:
Let me know how these look, and if you have any thoughts on how to move forward. The most obvious things for me are: