用于Ansible Playbook的AutoDoc
sphinxcontrib_ansibleautodoc的Python项目详细描述
sphinxcontrib ansibleautodoc是一个sphinx扩展,它可以在ansible playbook中搜索任务并生成文档。
安装
pip install sphinxcontrib-ansibleautodoc
并在conf.py的扩展中添加sphinxcontrib.ansibleautodoc'。
extensions = [ 'sphinxcontrib.ansibleautodoc', ]
如何使用
目前有一个指令名为ansibleautotask。
Ansibleautotask
.. ansibleautotask:: second task :playbook: ../ansible/web.yml
此指令的内容是一个可应答的任务名称。如果任务没有名称,则找不到指令。
playbook选项用于指定初始ansible playbook。AnsibleAutoDoc扫描剧本,将include和roles阅读如下。所以你只需要一个剧本文件。
输出示例
许可证
2条款BSD许可证