用途:从 Python 代码库生成 Markdown 文档,适用于整理 API 参考、README 与用法示例,或提取 docstring 和类型签名。
输入:单个 Python 文件路径、目录路径(递归处理 .py 文件)或指定文件列表。
输出:标准 Markdown,含模块名与模块简介、类(类说明与带类型注解的方法列表)、函数(签名、参数、返回值说明)以及用法示例段落。
主要能力:用 AST 或 inspect 解析源码;提取模块级 docstring、类定义与 docstring、函数与方法签名及类型注解、docstring 内容(支持 Google、NumPy、Sphinx 格式);按模块到类到方法再到函数的层级组织;生成格式统一的 Markdown。
质量与行为:尽量保留 docstring 原有格式;签名中突出类型提示;相关项分组(类归类、函数归函数);大型模块加目录;默认跳过下划线开头的私有成员,除非明确要求;缺少 docstring 时标注“No description provided”。
依赖:优先使用标准库 ast、inspect、pathlib,基础文档生成无需外部依赖。
错误处理:跳过有语法错误的文件并记录警告;优雅处理缺失类型注解;未发现 docstring 时警告但继续;处理前校验文件路径存在。
限制:资料未提供安装命令、价格、平台支持及量化效果信息。