mkapi:MkDocs的文档生成工具 源码
MkApi MkApi插件生成用于Python代码API文档。 MkApi支持两种类型的文档字符串:和 。 MkApi的功能有: 类型注释:如果您编写函数,例如def func(x: int) -> str:则无需再次在Parameters,Returns或Yields部分中写入类型。 您可以覆盖相应文档字符串中的类型注释。 对象类型检查:MkApi插件针对每个对象创建类,数据类,函数或发电机前缀。 属性检查:如果在模块或类中编写带有描述作为注释的属性,则会自动创建“属性”部分。 文档字符串继承:子类的文档字符串可以从其超类继承参数和属性描述。 目录:将目录插入每个包,模块和类的
文件列表
mkapi:MkDocs的文档生成工具
(预估有个102文件)
MANIFEST.in
145B
bases.jinja2
103B
module.jinja2
565B
member.jinja2
194B
macros.jinja2
2KB
node.jinja2
276B
object.jinja2
1KB
code.jinja2
691B
docstring.jinja2
697B
items.jinja2
501B
暂无评论