Merge pull request #4069 from tnir/4068-linkcheck-builder-docs

#4068: Update linkcheck docs to use requests
This commit is contained in:
Takeshi KOMIYA 2017-09-24 16:42:26 +09:00 committed by GitHub
commit cad3ee8230

View File

@ -423,8 +423,8 @@ instructions.
.. class:: CheckExternalLinksBuilder
This builder scans all documents for external links, tries to open them with
:mod:`urllib2`, and writes an overview which ones are broken and redirected
to standard output and to :file:`output.txt` in the output directory.
``requests``, and writes an overview which ones are broken and redirected to
standard output and to :file:`output.txt` in the output directory.
.. autoattribute:: name
@ -432,6 +432,10 @@ instructions.
.. autoattribute:: supported_image_types
.. versionchanged:: 1.5
Since Sphinx-1.5, the linkcheck builder comes to use requests module.
.. module:: sphinx.builders.xml
.. class:: XMLBuilder