diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index cd153d29b..000000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: docs - -on: - pull_request: - branches: - - '**' - # Only run when changes are made to the docs. - paths: - - 'docs/**' - -jobs: - markdown-link-check: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: gaurav-nelson/github-action-markdown-link-check@v1 - with: - use-quiet-mode: yes - use-verbose-mode: yes - check-modified-files-only: yes - base-branch: master diff --git a/.github/workflows/tox.yml b/.github/workflows/tox.yml index 8f45e22e6..bf7e529d5 100644 --- 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 index 51fbdd67c..92f6ccc80 100644 --- 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 index fa88f8318..088e242af 100644 --- 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 index d071054ea..31525091b 100644 --- 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