add myst_parser to allow markdown files in toclist in docs #316
Conversation
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
sverhoeven
approved these changes
Mar 17, 2022
Member
sverhoeven
left a comment
sverhoeven
left a comment
There was a problem hiding this comment.
Looks good to me.
Thanks, you have fixed #299
It would be nice to show or document that Markdown can be used in docs/ directory. For example add the CHANGELOG.md or some other existing *.md file in the toctree of index.rst .
Collaborator
Author
|
@sverhoeven Good suggestion. Personally, I put most markdown files under docs in my projects, because I don't like the root directory to be too stuffed. So, to showcase markdown support, I could do that here as well. Shall we discuss this further in a new issue and merge this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds the sphinx plugin
myst_parser. This allows you to add Markdown files directly to thetoclistinindex.rst. That way an unnecessary manual transformation step from Markdown to RST is avoided.