Python/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff synced 2026-01-07 22:54:28 -05:00
Code Issues Packages Projects Releases Wiki Activity

Normalize relative markdown links (#3190)

Browse Source
This commit is contained in:
Jonathan Plasse
2023-02-23 22:24:31 +01:00
committed by GitHub
parent a688a237d7
commit 6e54cd8233
4 changed files with 4 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
scripts/generate_mkdocs.py
View File

@@ -28,10 +28,6 @@ SECTIONS: list[Section] = [
Section("Contributing", "contributing.md", generated=True),
]
DOCUMENTATION_LINK: str = (
"For more, see the [documentation](https://beta.ruff.rs/docs/)."
)
FATHOM_SCRIPT: str = (
'<script src="https://cdn.usefathom.com/script.js" data-site="DUAEBFLB" defer>'
"</script>"
@@ -46,12 +42,6 @@ def main() -> None:
with Path("README.md").open(encoding="utf8") as fp:
content = fp.read()
# Remove the documentation link, since we're _in_ the docs.
if DOCUMENTATION_LINK not in content:
msg = "README.md is not in the expected format."
raise ValueError(msg)
content = content.replace(DOCUMENTATION_LINK, "")
# Convert any inter-documentation links to relative links.
content = content.replace("https://beta.ruff.rs", "")