Skip to content

Fix intersphinx references to myst-parser (updated in myst-parser 0.19) #10090

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

Merged
merged 1 commit into from
Mar 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user/guides/cross-referencing-with-sphinx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ with two markup options: reStructuredText and MyST (Markdown).
- If you are not familiar with reStructuredText,
check :doc:`sphinx:usage/restructuredtext/basics` for a quick introduction.
- If you want to learn more about the MyST Markdown dialect,
check out :doc:`myst-parser:syntax/syntax`.
check out :doc:`myst-parser:syntax/reference`.

.. contents:: Table of contents
:local:
Expand Down
2 changes: 1 addition & 1 deletion docs/user/guides/jupyter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ However, there are some differences between them:
whereas MyST-NB uses `MyST-Parser`_
to directly convert the Markdown text to docutils AST.
Therefore, nbsphinx assumes `pandoc flavored Markdown <https://pandoc.org/MANUAL.html#pandocs-markdown>`_,
whereas MyST-NB uses :doc:`MyST flavored Markdown <myst-parser:syntax/syntax>`.
whereas MyST-NB uses :doc:`MyST flavored Markdown <myst-parser:index>`.
Both Markdown flavors are mostly equal,
but they have some differences.
- nbsphinx executes each notebook during the parsing phase,
Expand Down
4 changes: 2 additions & 2 deletions docs/user/guides/migrate-rest-myst.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ and some others in reStructuredText, for whatever reason.
Luckily, Sphinx supports reading both types of markup at the same time without problems.

To start using MyST in your existing Sphinx project,
first {ref}``install the `myst-parser` Python package <myst-parser:intro.md#installation>``
and then {ref}`enable it on your configuration <myst-parser:intro.md#enable-myst-in-sphinx>`:
first [install the `myst-parser` Python package](https://myst-parser.readthedocs.io/en/stable/intro.html#installation)
and then [enable it on your configuration](https://myst-parser.readthedocs.io/en/stable/intro.html#enable-myst-in-sphinx):

```{code-block} py
:caption: conf.py
Expand Down