From 282c80c6df305d33e6f41c5527fde9eccc292043 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Mon, 12 May 2025 14:27:54 -0500 Subject: [PATCH] Include admonitions in the README transform (#333) These currently render weirdly: https://pypi.org/project/ty/ --- scripts/transform_readme.py | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/scripts/transform_readme.py b/scripts/transform_readme.py index bd5defe..d438744 100644 --- a/scripts/transform_readme.py +++ b/scripts/transform_readme.py @@ -24,7 +24,9 @@ def main() -> None: else: raise ValueError("Version not found in dist-workspace.toml") - # Replace any relative URLs (e.g., `[PIP_COMPATIBILITY.md`) with absolute URLs. + content = Path("README.md").read_text(encoding="utf8") + + # Replace any relative URLs (e.g., `[CONTRIBUTING.md`) with absolute URLs. def replace(match: re.Match) -> str: url = match.group(1) if not url.startswith("http"): @@ -33,9 +35,14 @@ def main() -> None: ) return f"]({url})" - content = re.sub( - r"]\(([^)]+)\)", replace, Path("README.md").read_text(encoding="utf8") - ) + content = re.sub(r"]\(([^)]+)\)", replace, content) + + # Replace any GitHub admonitions + def replace(match: re.Match) -> str: + name = match.group(1) + return f"> {name}:" + + content = re.sub(r"> \[\!(\w*)\]", replace, content) with Path("README.md").open("w", encoding="utf8") as fp: fp.write(content)