🐛 FIX: commonmark_only for directives

Author: chrisjsewell

myst_parser/docutils_renderer.py

@@ -363,7 +363,11 @@ def render_fence(self, token):
             token.info = token.info.strip()
         language = token.info.split()[0] if token.info else ""
 
-        if language.startswith("{") and language.endswith("}"):
+        if (
+            not self.config.get("commonmark_only", False)
+            and language.startswith("{")
+            and language.endswith("}")
+        ):
             return self.render_directive(token)
 
         if not language:

myst_parser/main.py

@@ -72,7 +72,9 @@ def default_parser(config: MdParserConfig) -> MarkdownIt:
         raise ValueError("unknown renderer type: {0}".format(config.renderer))
 
     if config.commonmark_only:
-        return MarkdownIt("commonmark", renderer_cls=renderer_cls)
+        md = MarkdownIt("commonmark", renderer_cls=renderer_cls)
+        md.options.update({"commonmark_only": True})
+        return md
 
     md = (
         MarkdownIt("commonmark", renderer_cls=renderer_cls)
@@ -104,6 +106,7 @@ def default_parser(config: MdParserConfig) -> MarkdownIt:
 
     md.options.update(
         {
+            "commonmark_only": False,
             "enable_html_img": config.html_img_enable,
             "myst_url_schemes": config.url_schemes,
         }

tests/test_sphinx/sourcedirs/commonmark_only/conf.py

@@ -0,0 +1,3 @@
+extensions = ["myst_parser"]
+exclude_patterns = ["_build"]
+myst_commonmark_only = True

tests/test_sphinx/sourcedirs/commonmark_only/index.md

@@ -0,0 +1,7 @@
+# Test
+
+```{note}
+hallo
+```
+
+{a}`b`

tests/test_sphinx/test_sphinx_builds.py

@@ -129,3 +129,28 @@ def test_footnotes(
         get_sphinx_app_doctree(app, docname="footnote_md", regress=True)
     finally:
         get_sphinx_app_output(app, filename="footnote_md.html", regress_html=True)
+
+
+@pytest.mark.sphinx(
+    buildername="html",
+    srcdir=os.path.join(SOURCE_DIR, "commonmark_only"),
+    freshenv=True,
+)
+def test_commonmark_only(
+    app,
+    status,
+    warning,
+    get_sphinx_app_doctree,
+    get_sphinx_app_output,
+    remove_sphinx_builds,
+):
+    """test setting addition configuration values."""
+    app.build()
+    assert "build succeeded" in status.getvalue()  # Build succeeded
+    warnings = warning.getvalue().strip()
+    assert "lexer name '{note}'" in warnings
+
+    try:
+        get_sphinx_app_doctree(app, docname="index", regress=True)
+    finally:
+        get_sphinx_app_output(app, filename="index.html", regress_html=True)

tests/test_sphinx/test_sphinx_builds/test_commonmark_only.html

@@ -0,0 +1,28 @@
+<div class="documentwrapper">
+ <div class="bodywrapper">
+  <div class="body" role="main">
+   <div class="section" id="test">
+    <h1>
+     Test
+     <a class="headerlink" href="#test" title="Permalink to this headline">
+      ¶
+     </a>
+    </h1>
+    <div class="highlight-{note} notranslate">
+     <div class="highlight">
+      <pre><span></span>hallo
+</pre>
+     </div>
+    </div>
+    <p>
+     {a}
+     <code class="docutils literal notranslate">
+      <span class="pre">
+       b
+      </span>
+     </code>
+    </p>
+   </div>
+  </div>
+ </div>
+</div>

tests/test_sphinx/test_sphinx_builds/test_commonmark_only.xml

@@ -0,0 +1,10 @@
+<document source="index.md">
+    <section ids="test" names="test">
+        <title>
+            Test
+        <literal_block language="{note}" xml:space="preserve">
+            hallo
+        <paragraph>
+            {a}
+            <literal>
+                b

tox.ini

@@ -13,16 +13,18 @@
 [tox]
 envlist = py{36,37,38}-sphinx{2,3},docs
 
-[testenv:py{36,37,38}-sphinx{2,3}]
+[testenv]
+# only recreate the environment when we use `tox -r`
 recreate = false
+
+[testenv:py{36,37,38}-sphinx{2,3}]
 extras = testing
 deps =
     sphinx2: sphinx>=2,<3
     sphinx3: sphinx>=3,<4
 commands = pytest {posargs}
 
 [testenv:docs]
-recreate = false
 extras = rtd
 whitelist_externals = rm
 commands =