用途:从 Python 源码生成 Markdown 文档,适合在用户要求“document this code”“generate docs”,或需要为 Python 模块创建 API 文档、生成带用法示例的 README、把 docstring 与类型签名整理成可读格式时使用。
主要能力:接受单个 Python 文件路径、目录路径(递归处理 .py 文件)或指定文件列表;输出标准 Markdown,包含模块名与模块 docstring 简介、Classes(类 docstring、方法签名与简述)、Functions(函数签名、docstring、参数与返回值说明)、Usage Examples(从 docstring 示例提取或生成基础用法)。分析方式为用 AST 或 inspect 解析 Python 文件,提取模块级 docstring、类定义与 docstring、带类型提示的函数/方法签名、docstring 内容(支持 Google、NumPy、Sphinx 格式),按模块→类→方法→函数分层组织,并生成格式一致的 Markdown。
质量约定:在有意义时保留原 docstring 格式;签名中突出类型提示;将相关项分组(类归类、函数归函数);大型模块添加目录;默认跳过以下划线开头的私有成员,除非明确要求;缺少 docstring 时优雅处理,标注“No description provided”。
工具与依赖:优先使用标准库,ast 用于解析、inspect 用于运行时内省、pathlib 用于文件处理;基础文档生成无需外部依赖。
错误处理:跳过有语法错误的文件并记录警告;优雅处理缺失的类型提示;未找到 docstring 时警告但继续处理;处理前校验文件路径存在。
限制:资料未提供具体安装命令、平台支持、收费方式或性能指标;实际输出质量取决于源码中 docstring 与类型提示的完整程度。