Skip to content

Commit 0b5e80e

Browse files
committed
Use mkdocs' builtin link checking
1 parent 06c211b commit 0b5e80e

File tree

5 files changed

+11
-26
lines changed

5 files changed

+11
-26
lines changed

.github/workflows/docs.yml

-21
This file was deleted.

.github/workflows/tox.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ jobs:
7171
fail-fast: false
7272
max-parallel: 4
7373
matrix:
74-
tox-env: [flake8, pep517check, checkspelling]
74+
tox-env: [flake8, pep517check, checklinks, checkspelling]
7575

7676
env:
7777
TOXENV: ${{ matrix.tox-env }}

mkdocs.yml

+6
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ nav:
5252
not_in_nav: |
5353
change_log/
5454
55+
validation:
56+
omitted_files: warn
57+
absolute_links: warn
58+
unrecognized_links: warn
59+
anchors: warn
60+
5561
markdown_extensions:
5662
- extra
5763
- admonition

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ testing = [
5353
'pyyaml'
5454
]
5555
docs = [
56-
'mkdocs>=1.5',
56+
'mkdocs>=1.6',
5757
'mkdocs-nature>=0.6',
5858
'mdx_gh_links>=0.2',
5959
"mkdocstrings[python]",

tox.ini

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ skip_install = true
2929
extras = docs
3030
deps = pyspelling
3131
commands =
32-
{envpython} -m mkdocs build --strict --config-file {toxinidir}/mkdocs.yml
32+
{envpython} -m mkdocs build --config-file {toxinidir}/mkdocs.yml
3333
{envpython} -m pyspelling --config {toxinidir}/.pyspelling.yml
3434

3535
[testenv:checklinks]
36-
whitelist_externals = markdown-link-check
36+
extras = docs
3737
deps =
38-
commands = {toxinidir}/checklinks.sh
38+
commands = {envpython} -m mkdocs build --strict --config-file {toxinidir}/mkdocs.yml
3939

4040
[testenv:pep517check]
4141
deps = pep517

0 commit comments

Comments
 (0)