Ansible自動文檔如何工作？

Question

所以這是我的情況： 我正在編寫Ansible劇本和角色在一個巨大的項目目錄。目前我的文檔存儲在.md文件中。但我想使用Ansible的文檔機制，所以我查看了獅身人面像文檔系統。它對我來說似乎很整潔，所以我安裝了它並進入了機制。

但我無法弄清楚：Ansible如何將位於python模塊中的文檔包含到sphinx文檔中？
我很抱歉不能更具體，但目前我只是抓住了我的假設。

因此，這裏是我想達到的目標：

• 我有典型的roles目錄
• 在這裏面有幾個角色
• 這些文件主要是.yaml或.yml文件
• 我至少希望包含這些角色目錄中的一個文件的文檔
• 理想情況下，我想從目錄
0123內的多個文件中提取文檔

如果太多不清楚請告訴我，我會盡力改善這個問題，因爲我無法弄清楚如何實現這個目標，甚至如何精確地提出問題。

在此先感謝您的每一個評論和回答！

Answer 1

自動文檔只適用於Ansible模塊，不適用於手冊。
如果你想記錄你的劇本，你是自己的。
github上有一個小項目：ansible-docgen - 它將任務列表提取到MD文件中，並添加了一對頭文件。
通過致電ansible-playbook --list-tasks myplaybook.yml

您可以達到可比的結果我個人認爲，閱讀帶評論的劇本非常方便。