sphinx.builders.linkcheck.HyperlinkAvailabilityCheckWorker

class documentation

class HyperlinkAvailabilityCheckWorker(Thread):

View In Hierarchy

A worker class for checking the availability of hyperlinks.
Method __init__ Undocumented
Method limit​_rate Undocumented
Method run Undocumented
Instance Variable ​_broken Undocumented
Instance Variable ​_good Undocumented
Instance Variable ​_redirected 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, builder=None):

Undocumented

Parameters
env:BuildEnvironmentUndocumented
config:ConfigUndocumented
rqueue:QueueUndocumented
wqueue:QueueUndocumented
rate​_limits:Dict[str, RateLimit]Undocumented
builder:CheckExternalLinksBuilderUndocumented
def limit_rate(self, response):

Undocumented

Parameters
response:ResponseUndocumented
Returns
Optional[float]Undocumented
def run(self):

Undocumented

_broken =

Undocumented

_good =

Undocumented

_redirected =

Undocumented

anchors_ignore =

Undocumented

auth =

Undocumented

config =

Undocumented

documents_exclude =

Undocumented

env =

Undocumented

rate_limits =

Undocumented

rqueue =

Undocumented

wqueue =

Undocumented