Module

health.linkcheck.internal_checker

Internal link checker for page-to-page and anchor validation.

View source
1 Class

Classes

InternalLinkChecker
Checker for internal links within a site. Validates: - Page-to-page links (resolved via paths) - A…
3

Checker for internal links within a site.

Validates:

  • Page-to-page links (resolved via paths)
  • Anchor links to headings (#section-id)
  • Relative links and absolute site links

Methods 1

check_links
Check internal links.
1 dict[str, LinkCheck… 
def check_links(self, links: list[tuple[str, str]]) -> dict[str, LinkCheckResult]

Check internal links.

Parameters 1
links list[tuple[str, str]]

List of (url, first_ref) tuples
Returns

dict[str, LinkCheckResult] —

Dict mapping URL to LinkCheckResult

Internal Methods 2
__init__
Initialize internal link checker.
2 None 
def __init__(self, site: Site, ignore_policy: IgnorePolicy | None = None)

Initialize internal link checker.

Parameters 2
site Site

Site instance with pages and xref_index
ignore_policy IgnorePolicy | None

Policy for ignoring certain links
_check_internal_link
Check a single internal link.
2 LinkCheckResult 
def _check_internal_link(self, url: str, refs: list[str]) -> LinkCheckResult

Check a single internal link.

Parameters 2
url str

Internal URL to check
refs list[str]

List of pages that reference this URL
Returns

LinkCheckResult —

LinkCheckResult