sphinx.builders.linkcheck

module documentation

The CheckExternalLinksBuilder class.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Class ​Check​External​Links​Builder Checks for broken external links.
Constant CHECK​_IMMEDIATELY Undocumented
Constant DEFAULT​_DELAY Undocumented
Constant DEFAULT​_REQUEST​_HEADERS Undocumented
Constant QUEUE​_POLL​_SECS Undocumented
Variable ​Check​Request​Type Undocumented
Variable logger Undocumented
Variable uri​_re Undocumented
Class ​Anchor​Check​Parser Specialized HTML parser that looks for a specific anchor.
Class ​Check​Request Undocumented
Class ​Check​Result Undocumented
Class ​Hyperlink Undocumented
Class ​Hyperlink​Availability​Checker Undocumented
Class ​Hyperlink​Availability​Check​Worker A worker class for checking the availability of hyperlinks.
Class ​Hyperlink​Collector Undocumented
Class ​Rate​Limit 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 node​_line​_or​_0 PriorityQueue items must be comparable. The line number is part of the tuple used by the PriorityQueue, keep an homogeneous type for comparison.
Function rewrite​_github​_anchor Rewrite anchor name of the hyperlink to github.com
Function setup Undocumented
CHECK_IMMEDIATELY: int =

Undocumented

Value
0
DEFAULT_DELAY: float =

Undocumented

Value
60.0
DEFAULT_REQUEST_HEADERS: dict[str, str] =

Undocumented

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

Undocumented

Value
1
CheckRequestType =

Undocumented

logger =

Undocumented

uri_re =

Undocumented

def check_anchor(response, anchor):
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):
Compile patterns in linkcheck_allowed_redirects to the regexp objects.
Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def node_line_or_0(node):
PriorityQueue items must be comparable. The line number is part of the tuple used by the PriorityQueue, keep an homogeneous type for comparison.
Parameters
node:ElementUndocumented
Returns
intUndocumented
def rewrite_github_anchor(app, uri):

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
Optional[str]Undocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented