-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Port pure Sphinx site to Jupyter Book 1 #846
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
Conversation
Does anyone use these?
* camel-glue: Use glue for camel graphic
Remove typo from README.md
Previous requirements forcing older versions of jupyter-book.
This reverts commit 6953285.
|
Built version at https://matthew-brett.github.io/scipy-lecture-notes/ Tests all passing; ready for review. |
* main: Pin to Jupyter Book 1.
* personal: Revert "Switch URLs back to main site"
Now that would get us Jupyter Book 2.
|
@matthew-brett This is a HUGE amount of work! A non-trivial challenge, and I am grateful to you for taking it on 🙏 This PR covers all the major concerns I had. There are probably some smaller issues we'll identify along the way, but I'd rather we get this merged and iterate (hopefully onward towards a mystmd version!). We have pointed several people at this PR, and there have been no comments that indicate significant concerns. I have also spoken with @bsipocz, and we have general consensus on the way forward. So, I'll merge for now, and we'll take it from there. Thanks! |
|
I also encourage others looking at this to read through the PR description and see the several benefits that already come with the port, even before switching to JBv2. |
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.