Port pure Sphinx site to Jupyter Book 1 #846
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Does anyone use these?
* camel-glue: Use glue for camel graphic
Remove typo from README.md
Previous requirements forcing older versions of jupyter-book.
|
Built version at https://matthew-brett.github.io/scipy-lecture-notes/ Tests all passing; ready for review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a port of the original pure Sphinx / Sphinx-gallery / ReST site to Jupyter Book 1 / sphinx-exercise / Myst Markdown.
We have deliberately stuck as closely to the original formatting as the Jupyter Book 1 conventions allow, including keeping the same tree structure and page names.
Jupyter Book 1 allows us to:
a) Get very close to the upcoming Jupyter Book 2 / Myst-MD format. We've already tested this last step to identify a few remaining incompatibilities or missing functionality, but, after this port, it will not be much work to get to Myst-MD.
b) Use sphinx-exercise as a standard format for exercises, where the exercises are drop-downs, as are the solutions.
c) Reduce code-duplication by moving much of the figure generation from separate
plot_*.pyfiles (the Sphinx-gallery idiom) either into the pages as hidden cells, or into separate notebooks, from which we abstract figures using the glue functionality.d) Reduce complexity for authors, by making it possible to run and edit tutorials as notebooks.
e) Plumb in JupyterLite, so the user can open tutorial pages as notebook in their browser.