集合文档编制

模块和插件文档编制

模块文档编制在模块格式和文档中进行了详细说明。插件的文档编制方式与模块相同，即使用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 目录。