sphinx.builders.linkcheck.CheckExternalLinksBuilder

class documentation

class CheckExternalLinksBuilder(DummyBuilder):

Checks for broken external links.

Class Variable	`name`	Undocumented
Method	`check_thread`	Undocumented
Method	`finish`	Finish the building process.
Method	`init`	Load necessary templates and perform initialization. The default implementation does nothing.
Method	`limit_rate`	Undocumented
Method	`process_result`	Undocumented
Method	`rqueue`	Undocumented
Method	`workers`	Undocumented
Method	`wqueue`	Undocumented
Method	`write_entry`	Undocumented
Method	`write_linkstat`	Undocumented
Class Variable	`epilog`	Undocumented
Instance Variable	`_broken`	Undocumented
Instance Variable	`_good`	Undocumented
Instance Variable	`_redirected`	Undocumented
Instance Variable	`_rqueue`	Undocumented
Instance Variable	`_wqueue`	Undocumented
Instance Variable	`hyperlinks`	Undocumented
Property	`anchors_ignore`	Undocumented
Property	`auth`	Undocumented
Property	`broken`	Undocumented
Property	`good`	Undocumented
Property	`redirected`	Undocumented
Property	`to_ignore`	Undocumented

Inherited from DummyBuilder:

Method	`get_outdated_docs`	Return an iterable of output files that are outdated, or a string describing what an update build will build.
Method	`get_target_uri`	Return the target URI for a document name.
Method	`prepare_writing`	A place where you can add logic before `write_doc` is run
Method	`write_doc`	Where you actually write something to the filesystem.
Class Variable	`allow_parallel`	Undocumented

Inherited from Builder (via DummyBuilder):

Method	`build`	Main build method.
Method	`build_all`	Build all source files.
Method	`build_specific`	Only rebuild as much as needed for changes in the filenames.
Method	`build_update`	Only rebuild what was changed or added since last build.
Method	`get_relative_uri`	Return a relative URI between two source filenames.
Class Variable	`default_translator_class`	Undocumented
Class Variable	`format`	Undocumented
Class Variable	`supported_data_uri_images`	Undocumented
Class Variable	`supported_image_types`	Undocumented
Class Variable	`supported_remote_images`	Undocumented
Instance Variable	`events`	Undocumented
Method	`__init__`	Undocumented
Method	`_read_parallel`	Undocumented
Method	`_read_serial`	Undocumented
Method	`_write_parallel`	Undocumented
Method	`_write_serial`	Undocumented
Method	`cleanup`	Cleanup any resources.
Method	`compile_all_catalogs`	Undocumented
Method	`compile_catalogs`	Undocumented
Method	`compile_specific_catalogs`	Undocumented
Method	`compile_update_catalogs`	Undocumented
Method	`create_template_bridge`	Return the template bridge configured.
Method	`create_translator`	Return an instance of translator.
Method	`get_asset_paths`	Return list of paths for assets (ex. templates, CSS, etc.).
Method	`get_builder_config`	Return a builder specific option.
Method	`get_translator_class`	Return a class of translator.
Method	`post_process_images`	Pick the best candidate for all image URIs.
Method	`read`	(Re-)read all files new or changed since last update.
Method	`read_doc`	Parse a file and add/update inventory entries for the doctree.
Method	`set_environment`	Store BuildEnvironment object.
Method	`write`	Undocumented
Method	`write_doc_serialized`	Handle parts of write_doc that must be called in the main process if parallel build is active.
Method	`write_doctree`	Write the doctree to a file.
Class Variable	`use_message_catalog`	Undocumented
Class Variable	`versioning_compare`	Undocumented
Class Variable	`versioning_method`	Undocumented
Instance Variable	`app`	Undocumented
Instance Variable	`confdir`	Undocumented
Instance Variable	`config`	Undocumented
Instance Variable	`doctreedir`	Undocumented
Instance Variable	`env`	Undocumented
Instance Variable	`finish_tasks`	Undocumented
Instance Variable	`imagedir`	Undocumented
Instance Variable	`images`	Undocumented
Instance Variable	`imgpath`	Undocumented
Instance Variable	`outdir`	Undocumented
Instance Variable	`parallel_ok`	Undocumented
Instance Variable	`srcdir`	Undocumented
Instance Variable	`tags`	Undocumented
Instance Variable	`templates`	Undocumented

name: str =

overrides sphinx.builders.dummy.DummyBuilder.name

Undocumented

def check_thread(self):

Undocumented

def finish(self):

overrides sphinx.builders.dummy.DummyBuilder.finish

Finish the building process.

The default implementation does nothing.

def init(self):

overrides sphinx.builders.dummy.DummyBuilder.init

Load necessary templates and perform initialization. The default implementation does nothing.

def limit_rate(self, response):

Undocumented

Parameters
response:`Response`	Undocumented
Returns
`Optional[float]`	Undocumented

def process_result(self, result):

Undocumented

Parameters
result:`CheckResult`	Undocumented

def rqueue(self, response):

Undocumented

Parameters
response:`Response`	Undocumented
Returns
`Queue`	Undocumented

def workers(self, response):

Undocumented

Parameters
response:`Response`	Undocumented
Returns
`List[Thread]`	Undocumented

def wqueue(self, response):

Undocumented

Parameters
response:`Response`	Undocumented
Returns
`Queue`	Undocumented

def write_entry(self, what, docname, filename, line, uri):

Undocumented

Parameters
what:`str`	Undocumented
docname:`str`	Undocumented
filename:`str`	Undocumented
line:`int`	Undocumented
uri:`str`	Undocumented

def write_linkstat(self, data):

Undocumented

Parameters
data:`dict`	Undocumented

epilog =

overrides sphinx.builders.dummy.DummyBuilder.epilog

Undocumented

_broken: Dict[str, str] =

Undocumented

_good: Set[str] =

Undocumented

_redirected: Dict[str, Tuple[str, int]] =

Undocumented

_rqueue: Queue[CheckResult] =

Undocumented

_wqueue: PriorityQueue[CheckRequestType] =

Undocumented

hyperlinks: Dict[str, Hyperlink] =

Undocumented

@property
anchors_ignore: List[Pattern] =

Undocumented

@property
auth: List[Tuple[Pattern, Any]] =

Undocumented

@property
broken: Dict[str, str] =

Undocumented

@property
good: Set[str] =

Undocumented

@property
redirected: Dict[str, Tuple[str, int]] =

Undocumented

@property
to_ignore: List[Pattern] =

Undocumented