集合文档编制

模块和插件文档编制

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

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

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

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

创建您的集合，并通过将其添加到您的COLLECTIONS_PATHS来确保您可以使用ansible-core。
创建一个名为dest的目录，然后运行antsibull-docs sphinx-init --use-current --dest-dir dest namespace.name，其中namespace.name是您的集合的名称。
进入dest目录并运行pip install -r requirements.txt。您可能需要首先创建一个虚拟环境并激活它，以避免全局安装。
然后运行./build.sh。
在您选择的浏览器中打开build/html/index.html。

有关完整详细信息，请参阅antsibull-docs文档。

如果您想在插件、模块和角色文档旁边向集合添加其他文档，请参阅docs目录。