文档化集合

文档化模块和插件

模块文档在 模块格式和文档 中进行了详细说明。插件可以像模块一样进行文档化，即使用 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 目录。