Skip to content

Commit 0aa1070

Browse files
committed
fix(docs): GitHub releases had 404's for :ref: links.
1 parent ab520ed commit 0aa1070

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

ci/parse_relnotes.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,14 @@ def refind(regex, text):
8484
else:
8585
return None
8686

87+
88+
def fix_ref_links(text, version):
89+
"""Find links to .rst files, and make them full RTFD links."""
90+
def new_link(m):
91+
return f"](https://coverage.readthedocs.io/en/{version}/{m[1]}.html{m[2]})"
92+
return re.sub(r"\]\((\w+)\.rst(#.*?)\)", new_link, text)
93+
94+
8795
def relnotes(mdlines):
8896
r"""Yield (version, text) pairs from markdown lines.
8997
@@ -97,6 +105,7 @@ def relnotes(mdlines):
97105
if version:
98106
prerelease = any(c in version for c in "abc")
99107
when = refind(r"\d+-\d+-\d+", htext)
108+
text = fix_ref_links(text, version)
100109
yield {
101110
"version": version,
102111
"text": text,

0 commit comments

Comments
 (0)