-
Notifications
You must be signed in to change notification settings - Fork 1
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
Use Myst instead of recommonmark #2
Conversation
This will require fixes in the various files.
There are some issues with how Myst is rendering it. I'm not sure what the problem is.
Stuff in ``` rst directives should be written in Markdown syntax with Myst.
I'm going to have to fix all the links to use proper references, unless executablebooks/MyST-Parser#149 is fixed by the upstream. |
Currently blocked on executablebooks/MyST-Parser#164 for the exact type table. It could be translated to a Markdown table, but it's not clear to me how to do the equivalent of rubric: footnote in MyST to make the footnotes appear next to the table instead of at the bottom of the document. |
MyST does not yet support eval_rst. This has a minor regression, which is that MyST always puts the footnotes at the bottom of the document. Previously they were right below the table.
We still need to fix the links that link to headers directly instead of using cross-references.
Also use a real Markdown footnote in the alternatives file.
We don't have any rst files anymore.
I went ahead and just put the footnotes at the bottom. It isn't a big deal. Everything else renders basically exactly the same, and we now have 100% pure Markdown everywhere, and we also were able to remove a lot of raw HTML too, including using real cross references for all the internal links. And the best part is now the build actually works without spurious warnings, which were impossible to get rid of with recommonmark. |
No description provided.