Add docs for the modules

* Added antsibull-docs config * Updated tox.ini to handle antsibull-docs * Updated antsibull-docs requirement in test_requirements.txt Signed-off-by: Abhijeet Kasurde <[email protected]>
ansible · Aug 19, 2024 · 25754eb · 25754eb
1 parent c08e7fc
commit 25754eb
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/.config/dictionary.txt b/.config/dictionary.txt
@@ -63,3 +63,9 @@ hdrs
 testuser
 testsecret
 keygen
+antsibull
+thead
+tbody
+darkgreen
+notranslate
+fqcn
diff --git a/test_requirements.txt b/test_requirements.txt
@@ -10,3 +10,4 @@ requests>=2.31.0
 ansible-rulebook>=1.0.0
 tox>=4.15.1
 podman-compose
+antsibull-docs==2.12.0
diff --git a/tox.ini b/tox.ini
@@ -107,3 +107,8 @@ commands =
   ansible-test coverage combine --export={envdir}
   # produces tests/output/reports/coverage.xml
   ansible-test coverage xml --requirements
+
+[testenv:docs]
+description = Generate plugins documentation under /docs directory using antsibull-docs
+commands =
+  antsibull-docs collection-plugins ansible.eda --dest-dir docs --use-current --output-format simplified-rst --fqcn-plugin-names