自动Ansible文档如何工作？

Question

所以这是我的情况： 我正在一个庞大的项目目录中编写Ansible剧本和角色。目前我的文档存储在.md文件中。但我想使用Ansible的文档机制，所以我查看了sphinx文档系统。对我来说看起来很漂亮，所以我安装了它并进入了机制。

但我无法弄清楚：Ansible如何将位于python模块中的文档包含在sphinx文档中？
我很抱歉不能更具体，但目前我只是在考虑我的表面。

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

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

如果太多不清楚，请告诉我，我会尽力改善这个问题，因为我无法弄清楚如何实现这一目标，甚至如何准确地提出问题。

提前感谢您的每一条评论和回答！

Answer 1

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

来获得可比较的结果

我个人认为，阅读带有评论的剧本非常方便。