Convert README to Markdown using MyST #1202
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
Owner
cjolowicz
commented
May 25, 2022
cjolowicz
commented
- ➕ [docs] Add myst-parser 0.17.2 to requirements
- 🔧 [sphinx] Enable Sphinx extension for myst-parser
- 📚 [README] Add Markdown version of README
- 📚 [README] Inline references from README in Sphinx docs
- 📚 [quickstart] Remove unused references
- 📚 [quickstart] Inline references into Guide
- 📚 [quickstart] Merge references
- 📚 [guide] Merge references
- 📚 [index] Merge references
- 📚 [index] Include Markdown version of README
- 📚 [guide] Include Markdown version of README
- 📚 [README] Fix undefined references in include into index
- 📚 [README] Group badges into three rows as before
- 📚 [README] Remove reST version of README
cjolowicz
added
documentation
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.