-
Notifications
You must be signed in to change notification settings - Fork 5
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 Examples #268
Update Examples #268
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice setup, should be easy to add examples and avoid stale notebook state. i think the only drawback with that is that the notebook output cells are not rendered, so, that makes reading the examples on the web somewhat ineffective. i'm happy to approve though and maybe we try and figure out how to render those cells on release.
thanks!
Yeah that's true that they won't be rendered from within GitHub but if everything works as expected, the outputs will be rendered in the html documentation once it gets built. Would that address your concern? |
Oh it does? Ya that's actually purrrfect |
Builds off of #238 to update our examples. Now, we have three main examples:
I also moved the examples to standard python scripts which should make them much easier to manage with version control / linting / formatting.
When building the docs, we can now call
python docs/examples/_convert_examples_to_notbooks.py
which converts all the examples to notebooks prior to building the docs since jupyter book expects them.Closes #238