4.9. sphinx.builders.linkcheck¶
The CheckExternalLinksBuilder class.
| copyright: | Copyright 2007-2016 by the Sphinx team, see AUTHORS. |
|---|---|
| license: | BSD, see LICENSE for details. |
4.9.1. Functions¶
TextIOWrapper(stream, encoding) |
|
build_opener(*handlers) |
Create an opener object from a list of handlers. |
check_anchor(f, hash) |
Reads HTML data from a filelike object ‘f’ searching for anchor ‘hash’. |
darkgray(text) |
|
darkgreen(text) |
|
darkred(text) |
|
encode_uri(uri) |
|
get_content_charset(f) |
|
purple(text) |
|
red(text) |
|
turquoise(text) |
|
unquote(() -> .) |
4.9.2. Classes¶
AnchorCheckParser(search_anchor) |
Specialized HTML parser that looks for a specific anchor. |
Builder(app) |
Builds target formats from the reST sources. |
CheckExternalLinksBuilder(app) |
Checks for broken external links. |
HTMLParser() |
Find tags and other markup and call handler functions. |
HTTPRedirectHandler |
|
HeadRequest(url[, data, headers, ...]) |
Subclass of urllib2.Request that sends a HEAD request. |
RedirectHandler |
A RedirectHandler that records the redirect code we got. |
Request(url[, data, headers, ...]) |
4.9.3. Exceptions¶
HTMLParseError(msg[, position]) |
Exception raised for all parse errors. |
HTTPError(url, code, msg, hdrs, fp) |
Raised when HTTP error occurs, but also acts like non-error return |