过时-改用sphinxcontrib autoyaml
sphinxcontrib-yaml的Python项目详细描述
这个sphinx autodoc扩展从注释中记录yaml文件。它在寻找 文档注释delimeter（默认值：###）并添加所有进一步的注释 作为rest文档，直到找到另一个delimeter或non-comment行。
选项
可在您的配置中使用的选项：
- autoyaml_root
- 查找与此目录相对应的yaml文件。 默认值：…
- autoyaml_doc_delimeter
- 开始文档注释的字符。
默认值
- autoyaml_comment
- 注释开始字符。 默认值：
示例
Some title========== Documenting all YAML files from directory recursively. ..autoyaml:: some_yml_dir Documenting single YAML file. ..autoyaml:: some_yml_file.yml
欢迎加入QQ群-->： 979659372
