Skip to content

Add an error message when both myst_nb and myst_parser included in extensions #713

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.

Sign up for GitHub

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

Open
frankier wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add an error message when both myst_nb and myst_parser included in extensions #713

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions myst_nb/sphinx_ext.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ def sphinx_setup(app: Sphinx):
# note, for core events overview, see:
# https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events

if "myst_parser" in app.extensions:
raise ValueError(
"Cannot load both myst_nb and myst_parser Sphinx extensions "
"-- load only myst_nb since it includes myst_parser"
Copy link
Copy Markdown
Member

@bsipocz bsipocz Apr 13, 2026

Choose a reason for hiding this comment

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

Maybe rephrase to be more clear about the action item:

Suggested change
"-- load only myst_nb since it includes myst_parser"
"-- please only list only myst_nb as an extension in your configuration since it includes myst_parser."

)

# Add myst-parser configuration and transforms (but does not add the parser)
setup_myst_parser(app)

Expand Down