Add MyST (Markdown) examples to "cross referencing with Sphinx" guide #8437
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericholscher
approved these changes
Aug 23, 2021
| @@ -263,7 +360,7 @@ That will be rendered as: | |||
| Invalid targets | |||
| --------------- | |||
|
|
|||
| If we reference an invalid or undefined target Sphinx will warn us. | |||
| If you reference an invalid or undefined target Sphinx will warn us. | |||
There was a problem hiding this comment.
Guessing we'll do a simple style guide here soon :)
There was a problem hiding this comment.
Getting closer :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds MyST (Markdown) examples to "cross-referencing with Sphinx" guide by using https://pypi.org/project/sphinx-tabs/, similarly to how we did in #8283. Basically all our reST samples are in our Sphinx guides - I started with one of them in this pull request to make reviews easier, but I can add a couple more guides.
While I was at it, I also reworded some parts to use second person and to clarify the role of reStructuredText vs Sphinx and put it on the same ground as MyST.
Got into a couple of rabbit holes while doing it, for example executablebooks/mdit-py-plugins#28. Also, "in-line" references are not supported at the moment, we didn't open an issue for it.