Skip to content

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

Merged
lukelbd merged 151 commits into
masterfrom
nbsphinx-docs
Nov 27, 2019
Merged

Organize documentation and sync ipython notebooks instead of nbconvert-generated RST files#47
lukelbd merged 151 commits into
masterfrom
nbsphinx-docs

Conversation

@lukelbd

Copy link
Copy Markdown
Collaborator

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.

@lukelbdlukelbd changed the title Sync ipython notebooks, so users can contribute to documentation and so examples can be auto testedSync ipython notebooks instead of nbconvert-generated RST and SVG filesSep 18, 2019
@lukelbdlukelbd mentioned this pull request Nov 27, 2019
@lukelbd

Copy link
Copy Markdown
CollaboratorAuthor

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 masterNov 27, 2019
@lukelbd
lukelbd deleted the nbsphinx-docs branch November 27, 2019 14:28
@lukelbd

Copy link
Copy Markdown
CollaboratorAuthor

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

Sign up for freeto 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

@lukelbd@bradyrx