From 25754eb1dcdb918ce59e7702d289c6d7b04b36e1 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Fri, 16 Aug 2024 16:18:29 -0700 Subject: [PATCH] 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 --- .config/dictionary.txt | 6 ++++++ test_requirements.txt | 1 + tox.ini | 5 +++++ 3 files changed, 12 insertions(+) diff --git a/.config/dictionary.txt b/.config/dictionary.txt index ce6203b0..2154fc74 100644 --- 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 index e2ced797..5840c562 100644 --- 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 index 30811e46..b2c739af 100644 --- 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