Integrate sphinx's linkcheck

.github/workflows/test.yml

@@ -4,7 +4,13 @@ on: [push, pull_request]
 
 jobs:
   build:
+    name: ${{ matrix.noxenv }}
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        noxenv:
+        - build
+        - linkcheck
 
     steps:
       - uses: actions/checkout@v2
@@ -27,6 +33,6 @@ jobs:
         run: |
           python -m pip install --upgrade nox virtualenv
 
-      - name: Nox build
+      - name: Nox ${{ matrix.noxenv }}
         run: |
-          python -m nox -s build
+          python -m nox -s ${{ matrix.noxenv }}

noxfile.py

@@ -52,3 +52,16 @@ def build(session, autobuild=False):
 def preview(session):
     session.install("sphinx-autobuild")
     build(session, autobuild=True)
+
+
+@nox.session(py="3")
+def linkcheck(session):
+    session.install("-r", "requirements.txt")
+    session.run(
+        "sphinx-build", 
+        "-b", "linkcheck", # use linkcheck builder
+        "--color",
+        "-n", "-W", "--keep-going",  # be strict
+        "source", # where the rst files are located
+        "build", # where to put the check output
+    )

source/conf.py

@@ -381,6 +381,10 @@
     'user': (f'{github_sponsors_url}/%s', '@'),  # noqa: WPS323
 }
 
+linkcheck_ignore = [
+    "http://localhost:\d+",
+]
+
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),