[Docs] Configure Myst-parser to parse anchor tag #1012
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
xinke-wang
approved these changes
May 12, 2022
6 tasks
This was referenced May 17, 2022
6 tasks
gaotongxiao
added a commit
to gaotongxiao/mmocr
that referenced
this pull request
Jul 15, 2022
gaotongxiao
added a commit
to gaotongxiao/mmocr
that referenced
this pull request
Jul 15, 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.
By default, myst-parser did not parse links to anchor tags in markdown files, making these hyperlinks become raw texts in docs. This PR updates
myst's configuration to enable this feature.For example:
https://mmocr--1012.org.readthedocs.build/en/1012/tutorials/dataset_types.html#id3
vs
https://mmocr.readthedocs.io/en/latest/tutorials/dataset_types.html#id3