sphinx.builders.linkcheck

module documentation
(source)

The CheckExternalLinksBuilder class.

Class AnchorCheckParser Specialized HTML parser that looks for a specific anchor.
Class CheckExternalLinksBuilder Checks for broken external links.
Class CheckRequest Undocumented
Class CheckResult Undocumented
Class Hyperlink Undocumented
Class HyperlinkAvailabilityChecker Undocumented
Class HyperlinkAvailabilityCheckWorker A worker class for checking the availability of hyperlinks.
Class HyperlinkCollector Undocumented
Class RateLimit Undocumented
Function check_anchor Reads HTML data from a response object `response` searching for `anchor`. Returns True if anchor was found, False otherwise.
Function compile_linkcheck_allowed_redirects Compile patterns in linkcheck_allowed_redirects to the regexp objects.
Function rewrite_github_anchor Rewrite anchor name of the hyperlink to github.com
Function setup Undocumented
Constant CHECK_IMMEDIATELY Undocumented
Constant DEFAULT_DELAY Undocumented
Constant DEFAULT_REQUEST_HEADERS Undocumented
Constant QUEUE_POLL_SECS Undocumented
Type Alias CheckRequestType Undocumented
Variable logger Undocumented
Variable uri_re Undocumented
def check_anchor(response, anchor): (source)

Reads HTML data from a response object `response` searching for `anchor`. Returns True if anchor was found, False otherwise.

Parameters
response:requests.requests.ResponseUndocumented
anchor:strUndocumented
Returns
boolUndocumented
def compile_linkcheck_allowed_redirects(app, config): (source)

Compile patterns in linkcheck_allowed_redirects to the regexp objects.

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def rewrite_github_anchor(app, uri): (source)

Rewrite anchor name of the hyperlink to github.com The hyperlink anchors in github.com are dynamically generated. This rewrites them before checking and makes them comparable.

Parameters
app:SphinxUndocumented
uri:strUndocumented
Returns
str|NoneUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
CHECK_IMMEDIATELY: int = (source)

Undocumented

Value
0
DEFAULT_DELAY: float = (source)

Undocumented

Value
60.0
DEFAULT_REQUEST_HEADERS: dict[str, str] = (source)

Undocumented

Value
{'Accept': 'text/html,application/xhtml+xml;q=0.9,*/*;q=0.8'}
QUEUE_POLL_SECS: int = (source)

Undocumented

Value
1
CheckRequestType = (source)

Undocumented

Value
Union[CheckRequest, Tuple[float, str, str, int]]
logger = (source)

Undocumented

uri_re = (source)

Undocumented