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
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 adds notebook rendering to the documentation page under an
Examplesheading. I found errors in the existing Griftpark notebooks so I didn't add them for now. All the Amersfoort notebooks should be there and seem to render ok.Note that it is not possible to render notebooks from
examples/directly in a portable fashion (see MiBiPreT/mibitrans#141) so currently there is a separate/docs/examplesdirectory that you must copy notebooks to if you want them to be included in the docs. In future there may be a better solution. If it's really annoying, we could think about a script to automatically copy notebooks over, but this is likely to confuse people so deliberately and explicitly choosing to copy certain notebooks still seems like a better option.You can test the rendering locally by running
pip install .[doc]to get the new docs dependencies down, and thenmkdocs serve