Switch to mkdocs-ansible (#3190)

.config/requirements-docs.txt

@@ -1,12 +1,2 @@
-cairosvg>=2.6.0
-markdown-exec>=1.3.0
-mkdocs-gen-files>=0.4.0
-mkdocs-htmlproofer-plugin>=0.10.2
-mkdocs-material-extensions>=1.1.1
-mkdocs-material>=9.0.13
-mkdocs>=1.4.2
-mkdocstrings-python>=0.8.3
-mkdocstrings>=0.20.0
-pillow>=9.4.0
+mkdocs-ansible>=0.1.2
 pipdeptree>=2.4.0
-pymdown-extensions>=9.9.2

.config/requirements-lock.txt

@@ -11,7 +11,7 @@ bracex==2.3.post1
 cffi==1.15.1
 click==8.1.3
 cryptography==39.0.2
-filelock==3.9.0
+filelock==3.9.1
 jinja2==3.1.2
 jsonschema==4.17.3
 markdown-it-py==2.2.0

.config/requirements.txt

@@ -20,6 +20,7 @@ colorama==0.4.6
 coverage==7.2.1
 coverage-enable-subprocess==1.0
 cryptography==39.0.2
+csscompressor==0.9.5
 cssselect2==0.7.0
 defusedxml==0.7.1
 dill==0.3.6
@@ -30,27 +31,33 @@ flake8==6.0.0
 flake8-future-annotations==1.1.0
 ghp-import==2.1.0
 griffe==0.25.5
+htmlmin==0.1.12
 idna==3.4
 importlib-metadata==6.0.0
 iniconfig==2.0.0
 isodate==0.6.1
 isort==5.12.0
 jinja2==3.1.2
+jsmin==3.0.1
 jsonschema==4.17.3
 lazy-object-proxy==1.9.0
 markdown==3.3.7
 markdown-exec==1.3.0
+markdown-include==0.8.1
 markdown-it-py==2.2.0
 markupsafe==2.1.2
 mccabe==0.7.0
 mdurl==0.1.2
 mergedeep==1.3.4
 mkdocs==1.4.2
+mkdocs-ansible==0.1.2
 mkdocs-autorefs==0.4.1
 mkdocs-gen-files==0.4.0
 mkdocs-htmlproofer-plugin==0.10.3
 mkdocs-material==9.1.2
 mkdocs-material-extensions==1.1.1
+mkdocs-minify-plugin==0.6.2
+mkdocs-monorepo-plugin==1.0.4
 mkdocstrings==0.20.0
 mkdocstrings-python==0.8.3
 mypy==1.1.1
@@ -76,6 +83,7 @@ pytest-mock==3.10.0
 pytest-plus==0.4.0
 pytest-xdist==3.2.1
 python-dateutil==2.8.2
+python-slugify==8.0.1
 pyyaml==6.0
 pyyaml-env-tag==0.1
 rdflib==6.2.0
@@ -89,6 +97,7 @@ six==1.16.0
 soupsieve==2.4
 spdx-tools==0.7.0
 subprocess-tee==0.4.1
+text-unidecode==1.3
 tinycss2==1.2.1
 tomli==2.0.1
 tomlkit==0.11.6

docs/configuring.md

@@ -35,15 +35,15 @@ The following values are supported, and function identically to their CLI
 counterparts:
 
 ```yaml
---8<-- ".ansible-lint"
+{!../.ansible-lint!}
 ```
 
 ## Ignoring rules for entire files
 
 Ansible-lint will load skip rules from an `.ansible-lint-ignore` or
-`.config/ansible-lint-ignore.txt` file that should reside adjacent to the config file.
-The file format is very simple, containing the filename and the rule to be ignored.
-It also supports comments starting with `#`.
+`.config/ansible-lint-ignore.txt` file that should reside adjacent to the config
+file. The file format is very simple, containing the filename and the rule to be
+ignored. It also supports comments starting with `#`.
 
 ```yaml title=".ansible-lint-ignore"
 # this is just a comment

mkdocs.yml

@@ -11,9 +11,7 @@ extra_css:
   - stylesheets/extra.css
 
 theme:
-  name: "material"
-  logo: images/logo.svg
-  favicon: images/favicon.ico
+  name: ansible
   features:
     - content.code.copy
     - content.action.edit
@@ -23,21 +21,6 @@ theme:
     - navigation.indexes
     - navigation.tracking
     - toc.integrate
-  palette:
-    - media: "(prefers-color-scheme: light)"
-      primary: teal
-      accent: blue
-      scheme: default
-      toggle:
-        icon: material/brightness-7
-        name: Switch to dark mode
-    - media: "(prefers-color-scheme: dark)"
-      scheme: slate
-      primary: teal
-      accent: blue
-      toggle:
-        icon: material/brightness-4
-        name: Switch to light mode
 extra:
   social:
     - icon: fontawesome/brands/python
@@ -145,8 +128,8 @@ plugins:
       scripts:
         - src/ansiblelint/generate_docs.py
   - search
-  - social
-  - tags
+  - material/social
+  - material/tags
   # https://github.com/manuzhang/mkdocs-htmlproofer-plugin
   # - htmlproofer
   - mkdocstrings:
@@ -164,14 +147,14 @@ plugins:
               domains: [py, std]
 
 markdown_extensions:
+  - markdown_include.include:
+      base_path: docs
   - admonition
   - def_list
   - footnotes
   - pymdownx.highlight:
       anchor_linenums: true
   - pymdownx.inlinehilite
-  - pymdownx.snippets:
-      check_paths: true
   - pymdownx.superfences
   - pymdownx.magiclink:
       repo_url_shortener: true