sphinx.builders.linkcheck.HyperlinkAvailabilityChecker

class documentation

class HyperlinkAvailabilityChecker:

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 builder 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, builder=None):

Undocumented

Parameters
env:BuildEnvironmentUndocumented
config:ConfigUndocumented
builder:CheckExternalLinksBuilderUndocumented
def check(self, hyperlinks):

Undocumented

Parameters
hyperlinks:Dict[str, Hyperlink]Undocumented
Returns
Generator[CheckResult, None, None]Undocumented
def invoke_threads(self):

Undocumented

def is_ignored_uri(self, uri):

Undocumented

Parameters
uri:strUndocumented
Returns
boolUndocumented
def shutdown_threads(self):

Undocumented

builder =

Undocumented

config =

Undocumented

env =

Undocumented

rate_limits: Dict[str, RateLimit] =

Undocumented

rqueue =

Undocumented

to_ignore =

Undocumented

workers: List[Thread] =

Undocumented

wqueue =

Undocumented