Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Configure Myst-parser to parse anchor tag #1589

Merged
merged 5 commits into from
May 17, 2022

Conversation

MeowZheng
Copy link
Collaborator

Motivation

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.

related pr open-mmlab/mmocr#1012

Modification

  1. docs/en/conf.py
  2. docs/zh_cn/conf.py

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMDet3D.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@MeowZheng MeowZheng changed the title Fix myst [Enhancement] Delete DS_Store file May 17, 2022
@MeowZheng MeowZheng changed the title [Enhancement] Delete DS_Store file [Docs] Configure Myst-parser to parse anchor tag May 17, 2022
@MeowZheng MeowZheng merged commit 4534fb6 into open-mmlab:master May 17, 2022
ZhimingNJ pushed a commit to AetrexTechnology/mmsegmentation that referenced this pull request Jun 29, 2022
* [Enhancement] Delete DS_Store file

* [Docs] Configure Myst-parser to parse anchor tag
aravind-h-v pushed a commit to aravind-h-v/mmsegmentation that referenced this pull request Mar 27, 2023
huajiangjiangLi pushed a commit to pytorchuser/HDB-Seg that referenced this pull request Apr 12, 2023
* [Enhancement] Delete DS_Store file

* [Docs] Configure Myst-parser to parse anchor tag
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants