蟒蛇文献用处
catnado-docgen的Python项目详细描述
#卡特纳多docgen
一个python文档实用程序，旨在与mkdocs一起工作。
最初是为[gae catnado]（https://tylertrussell.github.io/gae-catnado）建造的， 但也可能对其他项目有用。
通过pip install catnado docgen安装。
这是一项正在进行的工作！期待错误和未经通知的更改。
要遵循的实际更改日志。
##说明
####结合mkdocs.yaml
要在包含mkdocs.yaml文件的项目中记录包，只需运行： ` docgen build packagename mkdocs.yml --update-pages `
这将递归地扫描packagename，提取python docstring并构建 从中标记源文件。
新的标记文件将写入 docs目录（如mkdocs.yml中所指定）。
–update pages选项更新mkdocs.yml页面条目以包含 标题docgen api下包和子模块的嵌套结构。
####不带mkdocs.yml
如果要对生成的标记文档执行其他操作，可以 只需指定一个输出目录，如下所示：
docgen build packagename/my/path/此处
这将把标记源写入指定的目录。
欢迎加入QQ群-->： 979659372
