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

Migrate from recommonmark to MyST #1479

Closed
avan-sh opened this issue Apr 25, 2022 · 2 comments · Fixed by #1489 or #1503
Closed

Migrate from recommonmark to MyST #1479

avan-sh opened this issue Apr 25, 2022 · 2 comments · Fixed by #1489 or #1503
Labels
Component: DevSetup Issue/PR that addresses technical setup of the project repository Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@avan-sh
Copy link
Contributor

avan-sh commented Apr 25, 2022

Description

We use recommonmark plugin to write docs in markdown format, but this package has been deprecated and archived. The recommendation is to use MyST instead.

See readthedocs/recommonmark#221 for more info.

Context

Using mermaid in our docs as proposed by #1392 and any other future changes might require a switch to MyST as recommended by sphinxcontrib-mermaid.

Trying an older suggestion sphinxcontrib-mermaid (version 0.7) doesn't work, so it might still require the migration to MyST.

@datajoely
Copy link
Contributor

Love this

@merelcht merelcht added Component: Documentation 📄 Issue/PR for markdown and API documentation Component: DevSetup Issue/PR that addresses technical setup of the project repository labels Apr 26, 2022
@deepyaman
Copy link
Member

deepyaman commented Apr 26, 2022

@avan-sh I accidentally got here while trying to update #1392! I will try and close this out in the same issue, then (or I can separate it out, never say no to a commit).

edit: Definitely making a separate PR; turns out so many anchor links are broken, since they're not currently getting checked?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: DevSetup Issue/PR that addresses technical setup of the project repository Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
4 participants