GitHub Actions script for annotating results of Sphinx linkcheck

gha-sphinx-link-check.py

import pathlib
import json

docs_path = pathlib.Path("docs")
output_path = docs_path / "_build" / "linkcheck" / "output.json"

with output_path.open() as f:
  data = [json.loads(l) for l in f]

for record in data:
  if record['status'] != "broken":
    continue

  record['path'] = (docs_path / record['filename'])

  print(
    "::error file={path},line={lineno}::{uri} URI was {status} (code: {code}): {info}".format_map(record)
  )
  print(
    "??file={path},line={lineno}??{uri} URI was {status} (code: {code}): {info}".format_map(record)
  )