管理Ansible角色文档
ansidoc的Python项目详细描述
ansidoc
=
ansidoc是生成ansible角色文档的简单工具。
用法
-
>该工具使用来自多个来源的数据生成一个“readme.md”文件。
*role``default/main.yml``
*角色`` docs/*.yml``
*role``docs/*.md`
角色``vars/*``和``defaults/*``的内容也将直接插入到``yaml``代码块之间。对变量
的用途做些好的注释/解释！
角色“docs”目录可能包含要解析的yaml文件。中的变量
将用于充实生成的“readme.md”文件。所有标记文件
也将包括在内。顶部收割台必须为H2级。目前还没有定义包含顺序的
机制。
prepare your role
^^^^^^^^^^^^^^^^
代码块：：yaml
--
。代码块：：shell
用法：ansidoc[-h][-v][-v][-d][-s target][-nf][-e exclude][-p]dirpath
positional参数：
dirpath要么是“roles\u path”目录，要么是单个角色的路径。如果“RoeSyPATH”BaseNeNe:
角色，它将在子目录中循环，假设每个BR/>它们包含一个角色。
BR/>可选参数：
-H，帮助显示此帮助消息并退出
-V，-冗长增加输出冗长< BR/> -V，-版本显示程序的版本号并退出
-D，即干运行干运行，输出纯标记到STDUT，没有写到BR/> > BR/> -S目标（Doc S ReMe.MD）在PWD中创建一个链接到目标。
这是有用的，当从狮身人面像使用时，你不能添加
目录树中的相对项，如“../*”。如果未指定，则不创建符号链接。
-nf，--no ansidoc footer
不呈现ansidoc项目页脚。
-e exclude，--exclude exclude
csv要排除的角色名列表。必须与指定的“dirpath”
-p、-private考虑角色private下的目录名匹配，例如：从呈现模板的
github部分跳过安装。
>；从sphinx
^^^^^^^^^^^
就像您在
cli上所做的那样。
例如：
…代码块：：来自ansidoc的python
import ansidoc
ansidoc=ansidoc（dirpath=<；path/to/role>；，dry_run=true）
ansidoc.run（）
wishlist
-------
*角色依赖关系图示器
*角色变量分析（审核在何处定义的内容）
*为此程序创建sphinx文档
*使其成为sphinx插件
*按定义的顺序（按字母顺序）包含mardown文件？，给文件编号？）
*用自定义模板覆盖模板的部分。
*查找模板的搜索路径（\``.ansidoc/templates/*````\？）
*多角色变量
*查找配置的搜索路径（\`.ansidoc/config.yml```\？）
*排除配置文件中可配置的列表
许可证
----
----
*`Ansible DocGen<；https://github.com/toast38coza/Ansible DocGen>；``u
欢迎加入QQ群-->： 979659372
