Documentation improvement (#3946)

.ansible-lint-ignore

@@ -1,3 +1,3 @@
-# See https://ansible-lint.readthedocs.io/configuring/#ignoring-rules-for-entire-files
+# See https://ansible.readthedocs.io/projects/lint/configuring/#ignoring-rules-for-entire-files
 playbook2.yml package-latest # comment
 playbook2.yml foo-bar

.config/dictionary.txt

@@ -50,6 +50,7 @@ autodetected
 autodiscovery
 autodoc
 autofix
+autohide
 autorefs
 autoupdate
 awcrosby

.readthedocs.yml

@@ -11,7 +11,7 @@ build:
     python: "3.11"
   commands:
     - pip install --user tox
-    - python3 -m tox -e docs -- --strict --site-dir=_readthedocs/html/
+    - python3 -m tox -e docs
 python:
   install:
     - method: pip

README.md

@@ -53,11 +53,11 @@ ansible-lint was created by [Will Thames] and is now maintained as part of the
 [Ansible] by [Red Hat] project.
 
 [ansible]: https://ansible.com
-[contribution guidelines]: https://ansible-lint.readthedocs.io/contributing
+[contribution guidelines]: https://ansible.readthedocs.io/projects/lint/contributing
 [gplv3]: https://github.com/ansible/ansible-lint/blob/main/COPYING
 [mit]:
   https://github.com/ansible/ansible-lint/blob/main/docs/licenses/LICENSE.mit.txt
 [red hat]: https://redhat.com
 [will thames]: https://github.com/willthames
 [ansible-lint-action]:
-  https://ansible-lint.readthedocs.io/installing/#installing-from-source-code
+  https://ansible.readthedocs.io/projects/lint/installing/#installing-from-source-code

docs/installing.md

@@ -113,7 +113,7 @@ jobs:
 
 Due to limitations on how GitHub Actions are processing arguments, we do not
 plan to provide extra options. You will have to make use of
-[ansible-lint own configuration file](https://ansible-lint.readthedocs.io/configuring/)
+[ansible-lint own configuration file](https://ansible.readthedocs.io/projects/lint/configuring/)
 for altering its behavior.
 
 To also enable [dependabot][dependabot] automatic updates the newer versions of

mkdocs.yml

@@ -1,6 +1,6 @@
 ---
 site_name: Ansible Lint Documentation
-site_url: https://ansible-lint.readthedocs.io/
+site_url: https://ansible.readthedocs.io/projects/lint/
 repo_url: https://github.com/ansible/ansible-lint
 edit_uri: blob/main/docs/
 copyright: Copyright © 2023 Red Hat, Inc.
@@ -13,13 +13,28 @@ extra_css:
 theme:
   name: ansible
   features:
-    - content.code.copy
+    - announce.dismiss
     - content.action.edit
+    - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    - content.tabs.link
+    - content.tooltips
+    - header.autohide
     - navigation.expand
-    - navigation.sections
-    - navigation.instant
+    - navigation.footer
     - navigation.indexes
+    - navigation.instant
+    - navigation.path
+    - navigation.prune
+    - navigation.sections
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
     - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
     - toc.integrate
 extra:
   social:
@@ -46,11 +61,12 @@ extra:
       name: GitHub
 
 nav:
-  - User Guide:
+  - Home:
       - home: index.md
-      - philosophy.md
-      - installing.md
+      - Philosophy: philosophy.md
       - usage.md
+  - Setup:
+      - installing.md
       - configuring.md
       - profiles.md
       - autofix.md

pyproject.toml

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

src/ansiblelint/app.py

@@ -205,7 +205,7 @@ def report_outcome(
                 ignore_file.writelines(sorted(lines))
         elif matched_rules and not self.options.quiet:
             console_stderr.print(
-                "Read [link=https://ansible-lint.readthedocs.io/configuring/#ignoring-rules-for-entire-files]documentation[/link] for instructions on how to ignore specific rule violations.",
+                "Read [link=https://ansible.readthedocs.io/projects/lint/configuring/#ignoring-rules-for-entire-files]documentation[/link] for instructions on how to ignore specific rule violations.",
             )
 
         # Do not deprecate the old tags just yet. Why? Because it is not currently feasible

src/ansiblelint/constants.py

@@ -5,7 +5,7 @@
 
 DEFAULT_RULESDIR = Path(__file__).parent / "rules"
 CUSTOM_RULESDIR_ENVVAR = "ANSIBLE_LINT_CUSTOM_RULESDIR"
-RULE_DOC_URL = "https://ansible-lint.readthedocs.io/rules/"
+RULE_DOC_URL = "https://ansible.readthedocs.io/projects/lint/rules/"
 SKIP_SCHEMA_UPDATE = "ANSIBLE_LINT_SKIP_SCHEMA_UPDATE"
 
 ENV_VARS_HELP = {

test/test_internal_rules.py

@@ -5,4 +5,4 @@
 def test_base_rule_url() -> None:
     """Test that rule URL is set to expected value."""
     rule = BaseRule()
-    assert rule.url == "https://ansible-lint.readthedocs.io/rules/"
+    assert rule.url == "https://ansible.readthedocs.io/projects/lint/rules/"

test/test_loaders.py

@@ -31,7 +31,7 @@ def test_load_ignore_txt_default_success() -> None:
             _ignore_file.write(
                 dedent(
                     """
-                    # See https://ansible-lint.readthedocs.io/configuring/#ignoring-rules-for-entire-files
+                    # See https://ansible.readthedocs.io/projects/lint/configuring/#ignoring-rules-for-entire-files
                     playbook2.yml package-latest # comment
                     playbook2.yml foo-bar
                 """,

tox.ini

@@ -147,7 +147,7 @@ setenv =
 skip_install = false
 usedevelop = true
 commands =
-  mkdocs build {posargs:}
+  mkdocs {posargs:build --strict --site-dir=_readthedocs/html/}
 
 [testenv:redirects]
 description = Update documentation redirections for readthedocs