Improved documentation building

.config/dictionary.txt

@@ -1,8 +1,40 @@
+Adrián
+Autobuild
+CLICOLOR
+CODENOTIFY
+CODEOWNERS
+CTYPE
+Cacqueray
+Chamoulaud
+DISTRO
+DOTGLOB
+ENVVAR
+EPIPE # linux
+Fimport
+Jython
+MYTAG
+PYTHONBREAKPOINT
+PYTHONIOENCODING
+PYTHONPYCACHEPREFIX
+REQPASS
+RULEDIRS
+RUNLEVEL
+Renderable
+Representer
+SRCROOT
+Sbarnea
+Sorin
+Sshell
+TOXENV
+TYPECHECK
+Taskfiles
+Tsukinowa
+Tóth
+WSLENV
 aarch64
 abspath
 addoption
 addopts
-Adrián
 ansiblelint
 apidoc
 apport
@@ -11,7 +43,6 @@ argspecs
 arxcruz
 auditd
 autobuild
-Autobuild
 autoclass
 autodetected
 autodiscovery
@@ -35,23 +66,18 @@ buildinfo
 buildset
 builtins
 cachier
-Cacqueray
 capfd
 caplog
 capsys
 cffi
-Chamoulaud
 chdir
 chgrp
 chkconfig
 chunksize
 clib
-CLICOLOR
 codeclimate
 codecov
 codenotify
-CODENOTIFY
-CODEOWNERS
 codeql
 codespell
 colorama
@@ -65,7 +91,6 @@ coveragerc
 cpus
 cpuset
 createfile
-CTYPE
 darglint
 dataclasses
 dbservers
@@ -79,7 +104,6 @@ deps
 devel
 dharmabumstead
 dirhtml
-DISTRO
 dists
 distutils
 doas
@@ -88,15 +112,12 @@ doctest
 doctrees
 docutils
 dotconfig
-DOTGLOB
 dotslash
 drybjed
 dzdo
 ematcher
 ematchtestfile
 envrc
-ENVVAR
-EPIPE # linux
 execnet
 extlinks
 facelessuser
@@ -106,7 +127,6 @@ fileglob
 filelock
 filesspot
 filetree
-Fimport
 fips
 firewalld
 fontawesome
@@ -127,6 +147,7 @@ hostkey
 hostnames
 hostvars
 htmldir
+htmlproofer
 htpasswd
 hwchksum
 hwcksum
@@ -145,7 +166,6 @@ isort
 jsonfile
 jsonschema
 junitxml
-Jython
 keepends
 keyserver
 konstruktoid
@@ -187,7 +207,6 @@ modindex
 moduleauthor
 mypy
 myrole
-MYTAG
 namedtempfile
 nestedincludes
 netcommon
@@ -246,21 +265,15 @@ pyproject.toml
 pypy
 pyright
 pytest
-PYTHONBREAKPOINT
-PYTHONIOENCODING
-PYTHONPYCACHEPREFIX
 pyupgrade
 pyyaml
 redirections
 reexec
 regexes
 releasenotes
 relpath
-Renderable
 reportversion
 representer
-Representer
-REQPASS
 reqs
 returncode
 rmtree
@@ -271,13 +284,10 @@ ruamel
 rulebook
 rulebooks
 ruledirs
-RULEDIRS
 rulesdir
 rulesdirs
 runas
-RUNLEVEL
 sarif
-Sbarnea
 scalarint
 schemafile
 sdist
@@ -295,13 +305,10 @@ skippable
 skiptasks
 skiputils
 slaveinput
-Sorin
 sortfunc
 sourcegraph
-SRCROOT
 srpm
 ssbarnea
-Sshell
 stylesheet
 subdir
 subelements
@@ -315,7 +322,6 @@ supervisorctl
 synchronize
 sysvinit
 taskfile
-Taskfiles
 taskhandler
 taskimports
 taskincludes
@@ -336,11 +342,7 @@ toctree
 toidentifier
 tomli
 toolset
-Tóth
-TOXENV
 tripleo
-Tsukinowa
-TYPECHECK
 typehint
 typehints
 ulimits
@@ -377,7 +379,6 @@ webservers
 willthames
 workdir
 worktree
-WSLENV
 xdist
 xfail
 xunit

.config/requirements-docs.txt

@@ -1,6 +1,7 @@
 cairosvg
 markdown-exec>=1.0.0
 mkdocs-gen-files>=0.4.0
+mkdocs-htmlproofer-plugin
 mkdocs-material-extensions>=1.1.1
 mkdocs-material>=9.0.6
 mkdocs>=1.4.2

.config/requirements.txt

@@ -6,6 +6,7 @@
 #
 astroid==2.14.1
 attrs==22.2.0
+beautifulsoup4==4.11.2
 black==22.12.0
 bracex==2.3.post1
 cairocffi==1.4.0
@@ -45,6 +46,7 @@ mergedeep==1.3.4
 mkdocs==1.4.2
 mkdocs-autorefs==0.4.1
 mkdocs-gen-files==0.4.0
+mkdocs-htmlproofer-plugin==0.10.2
 mkdocs-material==9.0.11
 mkdocs-material-extensions==1.1.1
 mkdocstrings==0.20.0
@@ -79,6 +81,7 @@ rich==13.2.0
 ruamel-yaml==0.17.21
 setuptools==66.0.0
 six==1.16.0
+soupsieve==2.3.2.post1
 subprocess-tee==0.4.1
 tinycss2==1.2.1
 tomli==2.0.1

docs/configuring.md

@@ -47,10 +47,10 @@ Change **rev:** to either a commit sha or tag of Ansible-lint that contains
 `.pre-commit-hooks.yaml`.
 
 ```yaml
-- repo: https://github.com/ansible/ansible-lint.git
+- repo: https://github.com/ansible/ansible-lint
   rev: ... # put latest release tag from https://github.com/ansible/ansible-lint/releases/
   hooks:
     - id: ansible-lint
 ```
 
-[pre-commit]: https://pre-commit.com
+[pre-commit]: https://pre-commit.com/

docs/contributing.md

@@ -59,7 +59,8 @@ As with all Ansible projects, we have a [Code of Conduct].
   https://docs.ansible.com/ansible/latest/community/communication.html
 [code of conduct]:
   https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
-[creating your fork on github]: https://guides.github.com/activities/forking/
+[creating your fork on github]:
+  https://docs.github.com/en/get-started/quickstart/contributing-to-projects
 [discussions]: https://github.com/ansible/ansible-lint/discussions
 [supported ansible versions]:
   https://docs.ansible.com/ansible-core/devel/reference_appendices/release_and_maintenance.html#ansible-core-release-cycle

docs/index.md

@@ -16,7 +16,7 @@ community contributions and they can always be disabled based individually or by
 category by each user.
 
 [Ansible Galaxy project](https://github.com/ansible/galaxy/) makes use of this
-linter to compute quality scores for [Galaxy Hub](https://galaxy.ansible.com)
+linter to compute quality scores for [Galaxy Hub](https://galaxy.ansible.com/)
 contributed content. This does not mean this tool only targets those that want
 to share their code. Files like `galaxy.yml`, or sections like `galaxy_info`
 inside `meta.yml` help with documentation and maintenance, even for unpublished