Switch Markdown parser from Recommonmark to MyST-Parser #104
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
Also remove reference to video that no longer exists.
MyST-Parser requires links to be defined for .md files, which will be converted to .html by sphinx. This change also allows links to work when viewing the .md files on GitHub in a web browser.
MyST-Parser can display markdown tables correctly, unlike Recommonmark.
7 tasks
elegantmoose
approved these changes
Aug 18, 2022
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.
Description
Recommonmark is what we use to parse our markdown documentation for Sphinx, but it is no longer maintained. The recommendation is to use MyST-Parser instead, hence this pull request. MyST-Parser doesn't like links to
.htmlso I changed them to.md. This also has the side benefit that the links will also work when viewing the .md on GitHub.The other feature this allows is using Markdown tables. Recommonmark didn't support them so in many places we used bulleted lists instead of tables. In one instance we formatted the table as code, so I switched it to be parsed as a table.
Before:
After:
Type of change
How Has This Been Tested?
Built the docs after the changes, verified that pages still displayed correctly and links work.
Checklist: