Checking for broken links

Configuration

Adds a pyproject.toml file in the root directory:

[tool.pkgmt.check_links]
extensions = ["md", "rst", "py", "ipynb"] # list of files to look for links
ignore_substrings = ["127.0.0.1"] # optional: ignore links with any of these substrings

Checking

Important

This might report some HTTP codes as broken even when they’re not (e.g., we don’t consider 405 as a broken link anymore). If there are codes that we should not consider errors, please open an issue.

pkgmt check-links

To only consider 404 as broken:

pkgmt check-links --only-404

Tip

Run pkgmt check-links without the --only-404 to ensure you are not dismissing any broken link