测试插件文档

在开发过程中,可以使用 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

对于其他插件类型,步骤类似,只需根据特定类型调整名称和路径。