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 workflow + proper Cosmology docs #426
Conversation
- proper list of methods/attributes for Cosmology(), linking to classylss - solve RTD timeouts by using jupyter notebooks instead of ipython directive in docs - fix deprecated syntaxes in notebooks
The general workflow that I am using is doing: make notebooks
make html which executes all *ipynb files, and then builds the docs. Then, on RTD, the ipynb files are not re-executed, so we shouldn't bump up against the timeout limit |
Looks like magic, but as long as it works. I slightly liked the .rst files better than notebooks, because they have better looking diff-sets. |
Yeah the notebook solution is not ideal (although it's only the docs with the IPython directive that get replaced), but I think it's the cleanest solution at the moment. I imagine issues like this are why projects like yt have a dedicated machine to build the docs, custom domain, etc |
ah yes, I noticed that and meant to fix that in the docs. I'll do that now |
Looks like it is less code if you keep the duplicates around, but issue a warning instead? The 'dir' method of a cosmology object does return every member it can find -- will it be useful to simplify the autosummary code? would it be useful if we implement dir on the class instead? |
I think we should avoid leaving duplicates in the docs list, since that could be confusing for the user. For the auto summary list, I'm searching in the same manner as the Cosmology's getattr (not dir), so now it always links to the proper attribute that the user will get. This is also an issue for sigma8, where we overload the Spectra attribute in the Cosmology() class. |
FYI, I've built the docs with this update here: |
this addresses and closes #422 |
A few updates: