Skip to content

Use myst-md for admonishments to stay in markdown syntax #39

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

Merged
timkpaine merged 1 commit into from
Dec 12, 2024
Merged

Use myst-md for admonishments to stay in markdown syntax #39

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/src/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ graph TD
GitHub admonitions are automatically translated to sphinx.

> [!NOTE]
> Note content
> Note `markdown` content

> [!TIP]
> Tip content
Expand Down
4 changes: 2 additions & 2 deletions yardang/conf.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading