mkgendocs是一个Python工具，用于在markdown中从docstring自动生成文档
mkgendocs的Python项目详细描述
mkgendocs公司
一个Python包，用于在markdown中自动生成文档页 通过解析Google-style docstring来解析Python源文件。降价输出使它 与mkdocs结合的理想选择。在
我们不执行python代码（使用inspect包访问签名和docstring），而是直接从源文件中提取信息，方法是使用ast包将它们解析为抽象语法树（AST）。在
astor（AST observe/rewrite）包还用于将来自AST节点的函数或类签名转换回源代码字符串。在
安装
从PyPI安装mkgendocs
pipinstallmkgendocs
使用
^{pr2}$使用自动生成的文档创建源目录。 “examples”目录中的任何示例都会自动复制到文档中， 任何示例源文件的模块级docstring也会被复制并转换为markdown。在
配置示例
sources_dir:docs/sourcestemplates_dir:docs/templatespages:-page:"train/model.md"source:"tensorx/train/model.py"methods:-Model:-train-set_optimizer-page:"layers/core.md"source:'tensorx/layers.py'classes:-Linear-Module-page:"math.md"source:'tensorx/math.py'functions:-sparse_multiply_dense
- sources\u dir：创建结果降价文件的目录
- templates_dir：可以存储模板文件的目录。所有的文件夹和文件
已复制到源目录。任何降价文件都用作模板
模板文件中的标记
{{autogenerated}}被生成的文档替换。在 - pages：从各自的源文件和模板自动生成的页面列表：
- page：结果页的页面模板/源目录的路径
- source：要生成页面的源文件的路径
- methods：类到方法名字典的列表
- classes：要完全记录的类的列表
- functions：要记录的函数列表。在
给我买杯咖啡
太好了！咖啡咖啡真是太棒了！- 项目
标签：
欢迎加入QQ群-->： 979659372
