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

Organize documentation and sync ipython notebooks instead of nbconvert-generated RST files #47

Merged
merged 151 commits into from
Nov 27, 2019

Conversation

lukelbd
Copy link
Collaborator

@lukelbd lukelbd commented Sep 18, 2019

This will implement #32. I plan to sync ipython notebooks, have sphinx generate cell output automatically (and use this to automatically test changes, as an addendeum to scripts in tests, like climpred does), and use the auto-generated output in the documentation. Will also require more judicious merges/pushes to master, because the time for sphinx to generate documentation will probably go from ~1 minute to something like 5-10 minutes.

@lukelbd lukelbd changed the title Sync ipython notebooks, so users can contribute to documentation and so examples can be auto tested Sync ipython notebooks instead of nbconvert-generated RST and SVG files Sep 18, 2019
@lukelbd
Copy link
Collaborator Author

lukelbd commented Nov 27, 2019

Beautiful. We finally have some basic testing (make html with nbsphinx on every PR) and the documentation looks so much better. Hopefully RTD has no issues; merging now.

@lukelbd lukelbd merged commit 65702fb into master Nov 27, 2019
@lukelbd lukelbd deleted the nbsphinx-docs branch November 27, 2019 14:28
@lukelbd
Copy link
Collaborator Author

lukelbd commented Nov 27, 2019

RTD had memory usage issues. New docs should be live after readthedocs/readthedocs.org#6412 is resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants