Update documentation URLs

.config/dictionary.txt

@@ -23,6 +23,8 @@ fontawesome
 htmlproofer
 inlinehilite
 linenums
+linkchecker
+linkcheckerrc
 magiclink
 minversion
 mkdocs

.config/requirements.in

@@ -1,4 +1,5 @@
 cairosvg>=2.6.0
+linkchecker>=10.3.0
 markdown-exec>=1.3.0
 markdown-include>=0.8.1
 mkdocs-gen-files>=0.4.0

.config/requirements.txt

@@ -16,13 +16,15 @@ colorama==0.4.6
 csscompressor==0.9.5
 cssselect2==0.7.0
 defusedxml==0.7.1
+dnspython==2.4.2
 ghp-import==2.1.0
 griffe==0.38.0
 htmlmin2==0.1.13
 idna==3.4
 importlib-metadata==6.8.0
 jinja2==3.1.2
 jsmin==3.0.1
+linkchecker==10.3.0
 markdown==3.5.1
 markdown-exec==1.7.0
 markdown-include==0.8.1

docs/README.md

@@ -5,9 +5,9 @@ look and feel for any project related to [Ansible](https://docs.ansible.com/) ec
 
 Some of the projects that use this theme are:
 
-- [ansible-compat](https://ansible-compat.readthedocs.io/)
-- [ansible-devtools](https://ansible-devtools.readthedocs.io/)
-- [ansible-language-server](https://ansible-language-server.readthedocs.io/)
-- [ansible-lint](https://ansible-lint.readthedocs.io/)
-- [ansible-navigator](https://ansible-navigator.readthedocs.io/)
-- [molecule](https://molecule.readthedocs.io/)
+- [ansible-compat](https://ansible.readthedocs.io/projects/compat/)
+- [ansible-devtools](https://ansible.readthedocs.io/projects/dev-tools/)
+- [ansible-language-server](https://ansible.readthedocs.io/projects/language-server/)
+- [ansible-lint](https://ansible.readthedocs.io/projects/lint/)
+- [ansible-navigator](https://ansible.readthedocs.io/projects/navigator/)
+- [molecule](https://ansible.readthedocs.io/projects/molecule/)

linkcheckerrc

@@ -0,0 +1,12 @@
+# spell-checker:ignore checkextern robotstxt localwebroot ignorewarnings
+[filtering]
+checkextern=1
+ignore=
+  xml.gz$
+  404.html
+# https://github.com/squidfunk/mkdocs-material/pull/6386
+ignorewarnings=http-redirected
+
+[checking]
+robotstxt=0
+localwebroot=./

mkdocs.yml

@@ -1,6 +1,6 @@
 ---
 site_name: Ansible MkDocs Theme
-site_url: https://mkdocs-ansible.readthedocs.io/
+site_url: https://ansible.readthedocs.io/projects/mkdocs-ansible/
 site_author: Ansible
 site_description: >-
   This mkdocs theme is based on mkdocs-material and aims to provide a
@@ -97,3 +97,13 @@ markdown_extensions:
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.tilde
+
+validation:
+  nav:
+    omitted_files: warn
+    not_found: warn
+    absolute_links: warn
+  links:
+    not_found: warn
+    absolute_links: warn
+    unrecognized_links: warn

pyproject.toml

@@ -30,7 +30,7 @@ keywords = ["ansible", "mkdocs", "theme"]
 
 [project.urls]
 homepage = "https://github.com/ansible/mkdocs-ansible"
-documentation = "https://mkdocs-ansible.readthedocs.io/"
+documentation = "https://ansible.readthedocs.io/projects/mkdocs-ansible/"
 repository = "https://github.com/ansible/mkdocs-ansible"
 changelog = "https://github.com/ansible/mkdocs-ansible/releases"
 

tox.ini

@@ -84,7 +84,8 @@ setenv =
 skip_install = false
 usedevelop = true
 commands =
-  mkdocs build {posargs:}
+  mkdocs build --strict {posargs:}
+  linkchecker -f linkcheckerrc site
 
 [testenv:pkg]
 description =