Merge pull request #39 from python-project-templates/tkp/admon

Use myst-md for admonishments to stay in markdown syntax
python-project-templates · Dec 12, 2024 · ff244e6 · ff244e6
2 parents 24a807e + a151459
commit ff244e6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/src/configuration.md b/docs/src/configuration.md
@@ -235,7 +235,7 @@ graph TD
 GitHub admonitions are automatically translated to sphinx.
 
 > [!NOTE]
-> Note content
+> Note `markdown` content
 
 > [!TIP]
 > Tip content

diff --git a/yardang/conf.py.j2 b/yardang/conf.py.j2
@@ -170,7 +170,7 @@ def run_convert_github_admonitions_to_rst(app, filename, lines):
             # look for admonition key
             for admonition_key in _GITHUB_ADMONITIONS:
                 if admonition_key in line:
-                    line = line.replace(admonition_key, "\n```{}\n.. {}::\n".format("{eval-rst}", _GITHUB_ADMONITIONS[admonition_key]))
+                    line = line.replace(admonition_key, ":::{" + _GITHUB_ADMONITIONS[admonition_key] + "}\n")
                     # start replacing quotes in subsequent lines
                     replacing = True
                     break
@@ -180,7 +180,7 @@ def run_convert_github_admonitions_to_rst(app, filename, lines):
                     line = line.replace("> ", "  ")
                 elif replacing:
                     # missing "> ", so stop replacing and terminate directive
-                    line = f"\n```\n{line}"
+                    line = f"\n:::\n{line}"
                     replacing = False
             # swap line back in splits
             orig_line_splits[j] = line