diff options
| author | Christian Roth <code@christianroth.dev> | 2021-11-26 20:14:29 +0300 |
|---|---|---|
| committer | François Freitag <mail@franek.fr> | 2021-12-08 12:01:45 +0300 |
| commit | 10023da895ffc485a46e33fa951339a93b623c28 (patch) | |
| tree | 482e26703efac777e1bb3787b83953655d116f81 /doc | |
| parent | 471022b6dfebec964b1a646f9699374beb3d8a63 (diff) | |
linkcheck: Exclude links from matched documents
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/usage/configuration.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index cd6fa06a1..fe4357c77 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -2683,6 +2683,19 @@ Options for the linkcheck builder .. versionadded:: 3.4 +.. confval:: linkcheck_exclude_documents + + A list of regular expressions that match documents in which Sphinx should + not check the validity of links. This can be used for permitting link decay + in legacy or historical sections of the documentation. + + Example:: + + # ignore all links in documents located in a subfolder named 'legacy' + linkcheck_exclude_documents = [r'.*/legacy/.*'] + + .. versionadded:: 4.4 + Options for the XML builder --------------------------- |