自動Ansibleドキュメンテーションはどのように機能しますか？

Question

これは私の状況です： 私は、巨大なプロジェクトディレクトリの中で、無責任なプレイブックと役割を書いています。現在、私のドキュメントは.mdファイルに保存されています。しかし、私はAnipalのドキュメントメカニズムを使いたいので、私はsphinxドキュメントシステムを調べました。それは私にはきれいに見えるので、私はそれをインストールし、メカニズムに入った。

しかし、私は理解できません：どのようにAniiは、Pythonモジュールにあるドキュメントをスフィンクスのドキュメントに含めていますか？
もっと具体的にはできないのは残念ですが、現在は私が想定している表面だけを傷つけています。だからここ

は私が達成したいものです。

• 私はいくつかの役割
• ファイルは主に.yamlまたは.ymlファイル
• あるがあることで、典型的なrolesディレクトリ
• を持っています私は少なくとも、これらの役割のディレクトリ内の1つのファイルのドキュメントを含めることを望みます
• ディレクトリ内のいくつかのファイルからドキュメントを取得したいのですが

あまりにも不明な点がある場合は、私に教えてください。これを達成する方法や正確に質問する方法を数時間把握することはできません。

ご意見ありがとうございました！

Answer 1

自動ドキュメントは、PlayBookではなく、不可能なモジュール用です。
あなたのプレイブックを文書化したい場合は、あなた自身で行うことができます。
githubには小さなプロジェクトがあります：ansible-docgen - タスクのリストをMDファイルに取り出し、いくつかのヘッダーを追加します。
ansible-playbook --list-tasks myplaybook.yml

私の個人的な意見では、コメント付きでプレイブックを読むことは非常に便利です。