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

Convert ReST to Myst #103

Merged
merged 7 commits into from
Aug 12, 2024
Merged

Convert ReST to Myst #103

merged 7 commits into from
Aug 12, 2024

Conversation

rkdarst
Copy link
Member

@rkdarst rkdarst commented Aug 11, 2024

  • Use the procedure in rst-to-myst-config.yaml
  • Leave sample-episode-rst.rst (and get the new sample-episode-myst.md)
  • Worth checking the preview before merging.
  • If this is good, there should be other text updates in some of the
    pages to emphasize that MyST is the "default" documented mode.

- Use the procedure in rst-to-myst-config.yaml
- Leave sample-episode-rst.rst (and get the new sample-episode-myst.md)
- Worth checking the preview before merging.
- If this is good, there should be other text updates in some of the
  pages to emphasize that MyST is the "default" documented mode.
- Hard to self-demonstrate it when our preprocessor tries to process it.
- I'm not sure why colon fences and backquote-fences don't work then
  embedded in each other.
- MyST mixes document, ref, and HTML links in the same syntax, so this
  can't be forced to be a HTML link, so it tries to parse it as a
  semantic internal link, fails, and breaks the build.
- Temporary workaround: tell it to evaluate it as ReST and leave it as
  it was.
Copy link
Member

@bast bast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Approving. But I don't have the time now to check the preview.

@rkdarst
Copy link
Member Author

rkdarst commented Aug 12, 2024

If we want this (I'm pretty sure we do) it's ready to go. There were only some minor issues with things like MyST embedded in ReST where. it then got multipley interperted.

@rkdarst rkdarst merged commit d6da11f into master Aug 12, 2024
22 checks passed
@rkdarst rkdarst deleted the rkdarst/rst-to-myst branch August 12, 2024 08:10
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