added test for linkcheck_documents_exclude

sphinx/builders/linkcheck.py

@@ -249,7 +249,7 @@ def __init__(self, env: BuildEnvironment, config: Config, rqueue: Queue,
         self.anchors_ignore = [re.compile(x)
                                for x in self.config.linkcheck_anchors_ignore]
         self.documents_exclude = [re.compile(doc)
-                                 for doc in self.config.linkcheck_documents_exclude]
+                                  for doc in self.config.linkcheck_documents_exclude]
         self.auth = [(re.compile(pattern), auth_info) for pattern, auth_info
                      in self.config.linkcheck_auth]
 

tests/roots/test-linkcheck-documents_exclude/br0ken_link.rst

@@ -0,0 +1,5 @@
+Broken link
+===========
+
+Some links are `broken <https://www.sphinx-doc.org/this-is-another-broken-link>`__
+but sometimes not worrying about some broken links is a valid strategy.

tests/roots/test-linkcheck-documents_exclude/broken_link.rst

@@ -0,0 +1,5 @@
+Broken link
+===========
+
+Some links are `broken <https://www.sphinx-doc.org/this-is-a-broken-link>`__
+but sometimes not worrying about some broken links is a valid strategy.

tests/roots/test-linkcheck-documents_exclude/conf.py

@@ -0,0 +1,5 @@
+exclude_patterns = ['_build']
+linkcheck_documents_exclude = [
+    '^broken_link$',
+    'br[0-9]ken_link',
+]

tests/roots/test-linkcheck-documents_exclude/index.rst

@@ -0,0 +1,3 @@
+.. toctree::
+  broken_link
+  br0ken_link

tests/test_build_linkcheck.py

@@ -625,3 +625,14 @@ def test_get_after_head_raises_connection_error(app):
         "uri": "http://localhost:7777/",
         "info": "",
     }
+
+
+@pytest.mark.sphinx('linkcheck', testroot='linkcheck-documents_exclude', freshenv=True)
+def test_linkcheck_documents_exclude(app):
+    with http_server(make_redirect_handler(support_head=False)):
+        app.build()
+
+    with open(app.outdir / 'output.json') as fp:
+        for record in fp:
+            content = json.loads(record)
+            assert content['status'] == 'unchecked'