python - 自动 Ansible 文档是如何工作的？

Question

我的情况是这样的:我正在一个巨大的项目目录中编写 Ansible 剧本和角色。目前我的文档存储在 .md 文件中。但是我想使用Ansible的文档机制，所以我研究了sphinx文档系统。它对我来说似乎很整洁，所以我安装了它并进入了机制。

但我想不通的是:Ansible 如何将位于 python 模块中的文档包含到 sphinx 文档中？
很抱歉不能说得更具体，但目前我只是在摸索我假设的表面。

所以这就是我想要实现的目标:

• 我有典型的角色目录
• 里面有几个角色
• 文件主要是.yaml或.yml文件
• 我至少想在这些角色目录中包含来自一个文件的文档
• 理想情况下，我想从目录中的多个文件中提取文档

如果有太多不清楚的地方，请告诉我，我会尝试改进这个问题，因为我花了好几个小时都不知道如何实现这个，甚至不知道如何准确地提问。

预先感谢您的每一条评论和回答!

Answer 1

Auto doc 仅适用于 Ansible 模块，不适用于 playbook。
如果您想记录您的剧本，您只能靠自己了。
github上有个小项目:ansible-docgen – 它将任务列表提取到 MD 文件中并添加几个标题。
您可以通过调用 ansible-playbook --list-tasks myplaybook.yml

获得类似的结果

我个人认为，看有评论的playbook还是很方便的。