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

Switch to MyST-Parser from recommonmark for parse_markdown function #25

Merged
merged 1 commit into from
Apr 28, 2021
Merged

Switch to MyST-Parser from recommonmark for parse_markdown function #25

merged 1 commit into from
Apr 28, 2021

Conversation

jpmckinney
Copy link
Contributor

Related: #24

@jpmckinney
Copy link
Contributor Author

recommonmark will be sunset in about a month: readthedocs/recommonmark#221

@Bjwebb
Copy link
Member

Bjwebb commented Apr 28, 2021

Thanks for the heads up, I'm expecting we'll move all the sphinx sites we're responsible for over to MyST, although it may not happen until we come to update the requirements anyway.

@Bjwebb Bjwebb merged commit 2b2afef into OpenDataServices:main Apr 28, 2021
@jpmckinney jpmckinney deleted the myst-parser branch April 28, 2021 17:16
@jpmckinney
Copy link
Contributor Author

Thanks for the heads up, I'm expecting we'll move all the sphinx sites we're responsible for over to MyST, although it may not happen until we come to update the requirements anyway.

When you do, you can:

  • Eliminate the .. markdown directive, since it was only useful to fix a bug in recommonmark, where the content of a directive would be parsed as RST. (MyST parses everything as Markdown if the filename ends with .md)
  • Eliminate use of the parse_markdown function. As above, this is only needed when using recommonmark. The effect when using MyST is of parsing the same content twice.

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