sphinx.builders.linkcheck.HyperlinkAvailabilityChecker

Modules Classes Names

class documentation

class HyperlinkAvailabilityChecker: (source)

View In Hierarchy

Undocumented

Method	`__init__`	Undocumented
Method	`check`	Undocumented
Method	`invoke_threads`	Undocumented
Method	`is_ignored_uri`	Undocumented
Method	`shutdown_threads`	Undocumented
Instance Variable	`config`	Undocumented
Instance Variable	`env`	Undocumented
Instance Variable	`rate_limits`	Undocumented
Instance Variable	`rqueue`	Undocumented
Instance Variable	`to_ignore`	Undocumented
Instance Variable	`workers`	Undocumented
Instance Variable	`wqueue`	Undocumented

def __init__(self, env, config): (source) ¶

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
config:`Config`	Undocumented

def check(self, hyperlinks): (source) ¶

Undocumented

Parameters
hyperlinks:`dict[str, Hyperlink]`	Undocumented
Returns
`Generator[CheckResult, None, None]`	Undocumented

def invoke_threads(self): (source) ¶

Undocumented

def is_ignored_uri(self, uri): (source) ¶

Undocumented

Parameters
uri:`str`	Undocumented
Returns
`bool`	Undocumented

def shutdown_threads(self): (source) ¶

Undocumented

config = (source) ¶

Undocumented

env = (source) ¶

Undocumented

rate_limits: dict[str, RateLimit] = (source) ¶

Undocumented

rqueue: Queue[CheckResult] = (source) ¶

Undocumented

to_ignore = (source) ¶

Undocumented

workers: list[Thread] = (source) ¶

Undocumented

wqueue: PriorityQueue[CheckRequest] = (source) ¶

Undocumented