sphinx.builders.linkcheck.HyperlinkAvailabilityCheckWorker

class documentation

class HyperlinkAvailabilityCheckWorker(Thread): (source)

View In Hierarchy

A worker class for checking the availability of hyperlinks.

Method __init__ Undocumented
Method limit_rate Undocumented
Method run Undocumented
Instance Variable anchors_ignore Undocumented
Instance Variable auth Undocumented
Instance Variable config Undocumented
Instance Variable documents_exclude Undocumented
Instance Variable env Undocumented
Instance Variable rate_limits Undocumented
Instance Variable rqueue Undocumented
Instance Variable wqueue Undocumented
def __init__(self, env, config, rqueue, wqueue, rate_limits): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
config:ConfigUndocumented
rqueue:Queue[CheckResult]Undocumented
wqueue:Queue[CheckRequest]Undocumented
rate_limits:dict[str, RateLimit]Undocumented
def limit_rate(self, response): (source)

Undocumented

Parameters
response:ResponseUndocumented
Returns
float|NoneUndocumented
def run(self): (source)

Undocumented

anchors_ignore = (source)

Undocumented

auth = (source)

Undocumented

config = (source)

Undocumented

documents_exclude = (source)

Undocumented

env = (source)

Undocumented

rate_limits = (source)

Undocumented

rqueue = (source)

Undocumented

wqueue = (source)

Undocumented