Feat: HTML/GitHub pages version of curriculum #114
Merged
Conversation
This file contains 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
* Edit header levels for consistency * Add number (01, 02, etc) to Title for thumbnails and html pages * Execute some notebooks to show output; add to notebooks/clear_all_notebooks.py list
|
Dang @aleaf - this is really cool! I'm accepting the PR and thinking we should be good to go for the review/release unless any last-minute edits from @jlarsen-usgs, @jdhughes-usgs or @langevin-usgs Thanks for doing this! So I guess we just need to add a link to the gallery on the main README? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR adds an HTML version of the curriculum that includes galleries of the course notebooks rendered by nbsphinx. The idea is to provide a more polished website for the class that is easier to navigate and more searchable than the current notebooks rendered by GitHub. In addition to the galleries for parts 0 and 1 of the class (that would evolve with successive classes), we could also include a third 'bonus' gallery with cool notebooks from past classes or other relevant/useful examples. The lecture slides could also be converted to markdown and then rendered in the online docs using a tool like reveal.js. We could also add an FAQ that could be a living troubleshooting doc, etc.
A basic explanation of how the docs fit into the workflow
View the current docs on my fork
LMK what you think! @mnfienen @jdhughes-usgs @langevin-usgs @jlarsen-usgs