📚👌‼️: Improve documentation and usability#405
Merged
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## master #405 +/- ##
==========================================
+ Coverage 80.13% 80.44% +0.30%
==========================================
Files 20 21 +1
Lines 2059 2132 +73
==========================================
+ Hits 1650 1715 +65
- Misses 409 417 +8
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
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 PR completely restructures the documentation and makes a number of key usability improvements:
The previous usage of a jupytext configuration will still work, e.g.
but now the following can also signify a text-based notebook:
Note
display_nameis no longer required to be specified, since it is added as thename, if missing.The cell metadata key
renderis replaced withmystnb, to make it consistent with the notebook metadata key. For old notebooks usingrender, this will still be read and issue a deprecation warningThe
mystnb-quickstartCLI command has been added, to create a template Sphinx + MyST-NB project