[Docs] Developer guide for converting notebooks to rst; #135
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
added 7 commits
May 9, 2018 15:45
Included gotchas such as code not rendering due to bad ipython3 lexer and images not showing due to bad paths. Also included details on adding new classes/functions via the API section.
Added `docs/develop/plot.rst` to give some instruction on how we provide a cohesive plotting environment. Options for the `magicPlotDocDecorator` are included via `docs/magicPlotDoc.py` that give all the magic strings we look for when applying magicPlotDoc.
This helps git know not to attempt EOL conversions
Took some content from the git handbook to describe how to write a good git commit. These are helpful for our project, but also great practice for future projects.
DanKotlyar
approved these changes
May 10, 2018
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.
Closes #125
Add content largely to
docs/developin response to #123 where the plain conversionjupyter nbconvert --to=rstrequires minor intervention. The developer also has toipython3segments from the code blocksdocs/directoryAdd information on writing a good commit message using information from
git book