Repolode
提交项目
ml-tooling

ml-tooling/lazydocs

从 Google 风格 Python docstring 生成 Markdown 格式 API 文档的命令行工具，是 Sphinx 的轻量替代。

在 GitHub 查看
Star
253
Fork
42
未关闭 Issue
3
最近提交
15天前

这是什么？

Lazydocs 会扫描 Python 包、模块或指定的类与函数，根据其 Google 风格的 docstring 生成 Markdown 格式的 API 文档。既可以通过一条命令行指令运行，也可以在 Python 中调用其编程接口。默认输出到当前目录下的 ./docs 文件夹，也可以直接打印到标准输出。

生成的文件可以直接在 GitHub 的 Markdown 渲染中查看，也可以集成到 MkDocs 站点中。每个模块、类、方法和函数都可以附带指向源码文件和行号的链接，支持相对路径或自定义的基础 URL。可选的概览文件会将所有模块、类和函数集中列在一处。

通过 --validate 选项可以调用 pydocstyle 检查 docstring，发现问题时终止生成。其他选项可控制是否包含私有模块、是否添加目录和时间戳水印，以及输出为 md 还是 mdx 格式。

核心功能

  • 01根据 Google 风格的 Python docstring 生成 Markdown API 文档。
  • 02为模块、类、方法和函数添加指向源码文件与行号的链接。
  • 03可生成汇总所有模块、类和函数的 API 概览文件。
  • 04兼容 MkDocs 站点和 GitHub 的 Markdown 渲染。
  • 05生成前可选通过 pydocstyle 校验 docstring。

适用场景

  • 为 Python 库生成 API 参考页面，与 GitHub 仓库一同发布。
  • 在 MkDocs 文档站点中添加自动生成的 API 参考章节。
  • 在开发模块时将基于 docstring 的文档直接输出到控制台查看。

快速上手

  1. 1

    从 PyPI 安装 lazydocs

    pip install lazydocs
  2. 2

    为你的 Python 包生成 markdown 文档

    lazydocs path/to/your/package

使用前须知

  • 仅支持 Google 风格的 Python 文档字符串。

收录于专题

静态网站生成器与文档工具

标签

#python#documentation#api-docs#markdown#docstring#mkdocs#google-style#api-docs-generator#pydoc#python-api

常见问题

lazydocs 是什么？
从 Google 风格 Python docstring 生成 Markdown 格式 API 文档的命令行工具，是 Sphinx 的轻量替代。 Lazydocs 会扫描 Python 包、模块或指定的类与函数，根据其 Google 风格的 docstring 生成 Markdown 格式的 API 文档。既可以通过一条命令行指令运行，也可以在 Python 中调用其编程接口。默认输出到当前目录下的 ./docs 文件夹，也可以直接打印到标准输出。
lazydocs 可以免费使用吗？用的什么许可证？
lazydocs 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
lazydocs 还在维护吗？
活跃维护中。lazydocs 最近一次提交是在 2026年10月23日。
lazydocs 适合用来做什么？
为 Python 库生成 API 参考页面，与 GitHub 仓库一同发布。 在 MkDocs 文档站点中添加自动生成的 API 参考章节。 在开发模块时将基于 docstring 的文档直接输出到控制台查看。
lazydocs 怎么安装和运行？
从 PyPI 安装 lazydocs: pip install lazydocs 为你的 Python 包生成 markdown 文档: lazydocs path/to/your/package
在哪里获取 lazydocs？
源代码和安装说明在 GitHub 上：https://github.com/ml-tooling/lazydocs

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目