mirrors/ty
1
0
Fork 0
mirror of https://github.com/astral-sh/ty.git synced 2025-08-04 08:58:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Include admonitions in the README transform (#333)

Browse source 
These currently render weirdly: https://pypi.org/project/ty/
This commit is contained in:
Zanie Blue 2025-05-12 14:27:54 -05:00 • committed by GitHub
parent 86cd1f1229
commit 282c80c6df
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
scripts/transform_readme.py
View file

@ -24,7 +24,9 @@ def main() -> None:
else: else:
raise ValueError("Version not found in dist-workspace.toml") 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: def replace(match: re.Match) -> str:
url = match.group(1) url = match.group(1)
if not url.startswith("http"): if not url.startswith("http"):
@ -33,9 +35,14 @@ def main() -> None:
) )
return f"]({url})" return f"]({url})"
content = re.sub( content = re.sub(r"]\(([^)]+)\)", replace, content)
r"]\(([^)]+)\)", replace, Path("README.md").read_text(encoding="utf8")
) # 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: with Path("README.md").open("w", encoding="utf8") as fp:
fp.write(content) fp.write(content)