Add Markdown Parser to Sphinx #621
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
isVoid
added
doc
|
Can you please retarget this PR to 22.10? |
thomcom
approved these changes
Aug 3, 2022
|
@gpucibot merge |
raydouglass
approved these changes
Aug 3, 2022
There was a problem hiding this comment.
I don't think any changes are required to rapids-doc-env because myst-nb pulls in myst-parser.
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 Adds
Myst_parserextension to sphinx docs. This allows developers to write markdown pages for guides and references. In general, this is the more popular choice over reStructuredText. This PR also converts several text heavy documents into markdowns and fixes some build warnings.Note that rST is still supported and that the api reference folder remains in rST format. In general, markdown favors text heavy documentation such as guides and technical walk-through, while rST is suitable for creating reference trees.
This PR builds up the file organization proposed by #599 and generally follows the layouts of cudf.