From 0aa1070a2c9a99e10b7790b9a6a40a631ba5514e Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 23 May 2022 19:51:09 -0400 Subject: [PATCH] fix(docs): GitHub releases had 404's for :ref: links. --- ci/parse_relnotes.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/ci/parse_relnotes.py b/ci/parse_relnotes.py index d19e6d60c..ba5089ebf 100644 --- a/ci/parse_relnotes.py +++ b/ci/parse_relnotes.py @@ -84,6 +84,14 @@ def refind(regex, text): else: return None + +def fix_ref_links(text, version): + """Find links to .rst files, and make them full RTFD links.""" + def new_link(m): + return f"](https://coverage.readthedocs.io/en/{version}/{m[1]}.html{m[2]})" + return re.sub(r"\]\((\w+)\.rst(#.*?)\)", new_link, text) + + def relnotes(mdlines): r"""Yield (version, text) pairs from markdown lines. @@ -97,6 +105,7 @@ def relnotes(mdlines): if version: prerelease = any(c in version for c in "abc") when = refind(r"\d+-\d+-\d+", htext) + text = fix_ref_links(text, version) yield { "version": version, "text": text,