IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Close #6525: linkcheck: Add linkcheck_ignore_redirects

Browse Source 
Add a new confval; linkcheck_ignore_redirects to ignore hyperlinks
that are redirected as expected.
This commit is contained in:
Takeshi KOMIYA
2021-04-29 23:37:38 +09:00
parent 05eb2ca06f
commit 707319aab2
4 changed files with 69 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/usage/configuration.rst
View File

@@ -2522,6 +2522,25 @@ Options for the linkcheck builder
.. versionadded:: 1.1
.. confval:: linkcheck_ignore_redirects
A dictionary that maps a pattern of the source URI to a pattern of the canonical
URI. If set, linkcheck builder treated as "ignored" if a hyperlink in the source
document that matches to the pattern of the source URI, and it redirects to the
URL that matches to the pattern of the canonical URI. Example:
.. code-block:: python
linkcheck_ignore_redirects = {
# All HTTP redirections from the source URI to the canonical URI will be ignored.
'http://sphinx-doc.org/.*': 'https://sphinx-doc.org/en/master/.*'
}
It's helpful to enable :confval:`linkcheck_warn_redirects` not to warn the URIs
that causes HTTP redirection as expected.
.. versionadded:: 4.1
.. confval:: linkcheck_request_headers
A dictionary that maps baseurls to HTTP request headers.