Doc: Automatic generation of docs for collection plugins (aristanetwo…

…rks#3061)
Vibhu-gslab · Sep 8, 2023 · 7cb8d1f · 7cb8d1f
1 parent de022e8
commit 7cb8d1f
Show file tree

Hide file tree

Showing 77 changed files with 2,702 additions and 1,548 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -123,6 +123,35 @@ repos:
 
   - repo: local
     hooks:
+
+      - id: docs-plugin-modules
+        name: Build documentation for collection modules and action plugins
+        entry: ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 --markdown "ansible_collections/arista/avd/docs/plugins/Modules and action plugins/"
+        language: system
+        types: [python]
+        files: ansible_collections/arista/avd/plugins/modules/
+
+      - id: docs-plugin-filter
+        name: Build documentation for collection filter plugins
+        entry: ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 --markdown "ansible_collections/arista/avd/docs/plugins/Filter plugins/"
+        language: system
+        types: [python]
+        files: ansible_collections/arista/avd/plugins/filter/
+
+      - id: docs-plugin-test
+        name: Build documentation for collection test plugins
+        entry: ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 --markdown "ansible_collections/arista/avd/docs/plugins/Test plugins/"
+        language: system
+        types: [python]
+        files: ansible_collections/arista/avd/plugins/test/
+
+      - id: docs-plugin-vars
+        name: Build documentation for collection var plugins
+        entry: ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 --markdown "ansible_collections/arista/avd/docs/plugins/Vars plugins/"
+        language: system
+        types: [python]
+        files: ansible_collections/arista/avd/plugins/vars/
+
       - id: schemas
         name: Build AVD Schemas and Documentation
         entry: sh -c 'exec env ANSIBLE_COLLECTIONS_PATHS=`pwd` ansible-playbook --forks 10 arista.avd._build_schemas_and_docs'

diff --git a/Makefile b/Makefile
@@ -1,8 +1,6 @@
 CURRENT_DIR = $(shell pwd)
 # option to run ansible-test sanity: must be either venv or docker (default is docker)
 ANSIBLE_TEST_MODE ?= docker
-# Root path for MKDOCS content
-WEBDOC_BUILD = ansible_collections/arista/avd/docs/_build
 MUFFET_TIMEOUT ?= 60
 
 .PHONY: help

diff --git a/ansible_collections/arista/avd/docs/Dockerfile b/ansible_collections/arista/avd/docs/Dockerfile