集合文档编制

模块和插件文档编制

模块文档编制在模块格式和文档中进行了详尽的说明。插件的文档编制方式与模块相同，即使用 DOCUMENTATION、EXAMPLES 和 RETURN 块。

角色文档编制

要编写角色文档，必须通过在角色中创建 meta/argument_specs.yml 文件来添加角色参数规范。详情请参见角色参数验证。例如，你可以查看 GitHub 上 sensu.sensu_go.install 角色的参数规范文件。

验证你的集合文档

你可以使用 antsibull-docs 来检查你的集合文档。详情请参见集合文档检查。

使用 antsibull-docs 构建文档站点

你可以使用 antsibull-docs 为你的集合构建基于 Sphinx 的文档站点。

1. 创建你的集合，并确保可以通过将其添加到你的COLLECTIONS_PATHS来与 ansible-core 一起使用。

2. 创建一个目录 dest 并运行 antsibull-docs sphinx-init --use-current --dest-dir dest namespace.name，其中 namespace.name 是你的集合的名称。

3. 进入 dest 并运行 pip install -r requirements.txt。你可能需要先创建一个虚拟环境并激活它，以避免全局安装。

4. 然后运行 ./build.sh。

5. 在选择的浏览器中打开 build/html/index.html。

有关完整详情，请参见 antsibull-docs 文档。

如果要除了插件、模块和角色文档之外，向集合添加其他文档，请参见docs 目录。