测试插件文档

在开发过程中，一个快速测试方法是使用 ansible-doc -t <plugin_type> <name> 来查看它是否能渲染，如果模块不在 Ansible 期望找到它的位置，你可能需要添加 -M /path/to/module。

在提交插件以包含在 ansible-core 中之前，你必须运行测试以确保 argspec 与 Python 文件中的文档匹配，并且 argspec 和文档的结构正确。

如果你使用额外的 RST 文件扩展了 Ansible 文档，社区页面提供了更多关于本地测试 reStructuredText 文档的信息。

为了确保你的模块文档与你的 argument_spec 相匹配

1. 安装所需的 Python 包（在 venv/virtualenv 中删除 ‘–user’）

   pip install --user -r test/lib/ansible_test/_data/requirements/sanity.txt
   

2. 运行 validate-modules 测试

   ansible-test sanity --test validate-modules mymodule
   

如果安装了 Docker 或 Podman，你也可以使用 --docker 选项，它使用一个已经安装了所有需求的镜像

ansible-test sanity --docker --test validate-modules mymodule

对于其他插件类型，步骤类似，只需调整名称和路径以适应特定类型。