Function main

tools/check_docs_github_links.py:49–77

(argv=None)

def main(argv=None):
    parser = argparse.ArgumentParser(
        description="Reject docs links that point to moving GitHub source refs."
    )
    parser.add_argument("--root", default="docs", help="Directory to scan.")
    parser.add_argument(
        "--repo-slug", required=True, help="Example: PaddlePaddle/PaddleOCR"
    )
    parser.add_argument(
        "--forbidden-ref",
        action="append",
        required=True,
        help="Moving source ref to reject. Can be passed multiple times.",
    )
    args = parser.parse_args(argv)

    violations = find_forbidden_links(
        args.root,
        repo_slug=args.repo_slug,
        forbidden_refs=set(args.forbidden_ref),
    )
    if violations:
        for violation in violations:
            print(
                f"{violation.path}:{violation.line_number}: "
                f"forbidden GitHub ref '{violation.ref}' in {violation.url}"
            )
        return 1
    return 0


if __name__ == "__main__":