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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guide to migrate from reST to MyST #8714

Merged
merged 6 commits into from
Nov 30, 2021
Merged

Conversation

astrojuanlu
Copy link
Contributor

And of course, it's written in MyST 馃槂

cc @choldgraf and @chrisjsewell since this makes numerous references to myst-parser and rst-to-myst.

@astrojuanlu astrojuanlu requested review from a team as code owners November 24, 2021 15:58
@astrojuanlu
Copy link
Contributor Author

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

馃帀

docs/guides/migrate-rest-myst.md Show resolved Hide resolved
docs/guides/migrate-rest-myst.md Outdated Show resolved Hide resolved
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Looks good to me 馃憤

docs/guides/migrate-rest-myst.md Outdated Show resolved Hide resolved
Copy link
Contributor

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

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

It looks good to me! Just two minor comments, nothing blocking. Thanks for writing this up!

docs/guides/migrate-rest-myst.md Outdated Show resolved Hide resolved
that will parse the content as reStructuredText, rather than MyST.
For example:

````
Copy link
Contributor

Choose a reason for hiding this comment

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

Side-note, I really wish there was a sphinx extension like

Here's an example of `eval-rst` in action:

````{demo}
```{eval-rst}
.. note:: This is a note
```
````

And it would render as tabbed content with two tabs where the left is "rendered" and the right is "source code"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, that would be very useful for tutorial writing! If only I had it 6 months ago 馃槤

@astrojuanlu astrojuanlu merged commit f652672 into master Nov 30, 2021
@astrojuanlu astrojuanlu deleted the migrate-rest-myst branch November 30, 2021 09:16
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.

None yet

4 participants