Use mkdocs' builtin link checking

waylan · Oct 1, 2024 · 0b5e80e · 0b5e80e
1 parent 06c211b
commit 0b5e80e
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 26 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/.github/workflows/tox.yml b/.github/workflows/tox.yml
@@ -71,7 +71,7 @@ jobs:
       fail-fast: false
       max-parallel: 4
       matrix:
-        tox-env: [flake8, pep517check, checkspelling]
+        tox-env: [flake8, pep517check, checklinks, checkspelling]
 
     env:
       TOXENV: ${{ matrix.tox-env }}

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -52,6 +52,12 @@ nav:
 not_in_nav: |
   change_log/
 
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
+  anchors: warn
+
 markdown_extensions:
   - extra
   - admonition

diff --git a/pyproject.toml b/pyproject.toml
@@ -53,7 +53,7 @@ testing = [
     'pyyaml'
 ]
 docs = [
-    'mkdocs>=1.5',
+    'mkdocs>=1.6',
     'mkdocs-nature>=0.6',
     'mdx_gh_links>=0.2',
     "mkdocstrings[python]",

diff --git a/tox.ini b/tox.ini
@@ -29,13 +29,13 @@ skip_install = true
 extras = docs
 deps = pyspelling
 commands =
-    {envpython} -m mkdocs build --strict --config-file {toxinidir}/mkdocs.yml
+    {envpython} -m mkdocs build --config-file {toxinidir}/mkdocs.yml
     {envpython} -m pyspelling --config {toxinidir}/.pyspelling.yml
 
 [testenv:checklinks]
-whitelist_externals = markdown-link-check
+extras = docs
 deps =
-commands = {toxinidir}/checklinks.sh
+commands = {envpython} -m mkdocs build --strict --config-file {toxinidir}/mkdocs.yml
 
 [testenv:pep517check]
 deps = pep517