mkapi:MkDocs的文档生成工具

时间:2024-02-24 23:18:27
【文件属性】:

文件名称:mkapi:MkDocs的文档生成工具

文件大小:86KB

文件格式:ZIP

更新时间:2024-02-24 23:18:27

markdown api-documentation mkdocs-plugin MarkdownPython

MkApi MkApi插件生成用于Python代码API文档。 MkApi支持两种类型的文档字符串:和 。 MkApi的功能有: 类型注释:如果您编写函数,例如def func(x: int) -> str:则无需再次在Parameters,Returns或Yields部分中写入类型。 您可以覆盖相应文档字符串中的类型注释。 对象类型检查:MkApi插件针对每个对象创建类,数据类,函数或发电机前缀。 属性检查:如果在模块或类中编写带有描述作为注释的属性,则会自动创建“属性”部分。 文档字符串继承:子类的文档字符串可以从其超类继承参数和属性描述。 目录:将目录插入每个包,模块和类的


网友评论