Repolode
提交项目
pdoc3

pdoc3/pdoc

从 Python 模块、包和 docstring 自动生成 API 文档，无需复杂配置。

在 GitHub 查看官网
Star
1,187
Fork
146
未关闭 Issue
111
最近提交
3个月前

这是什么？

pdoc 是一个命令行工具，用于为 Python 项目生成 HTML 格式的 API 文档。你可以传入模块文件、包目录或导入路径，它会连同 docstring 和类型注解一起渲染公开对象。

它支持 Markdown、numpydoc 和 Google 风格等常见 docstring 格式，可渲染 LaTeX 数学公式和部分 reST 指令，并在定义了 __all__ 时遵循其范围。未指定文档字符串的子类成员会继承父类的说明，模块、类及实例变量通过遍历 AST 提取文档，标识符之间自动互相链接。

输出可通过模板自定义，也可以用模块级的 __pdoc__ 字典覆盖文档字符串。内置的开发服务器可在编辑时实时预览渲染结果。

核心功能

  • 01支持从模块、包目录或导入路径生成 HTML 文档。
  • 02支持 Markdown、numpydoc 和 Google 风格的 docstring。
  • 03支持 PEP 484 和 PEP 526 类型注解。
  • 04未写文档的覆盖成员自动继承父类文档。
  • 05自动为引用的标识符添加交叉链接。
  • 06支持自定义模板，并内置实时预览服务器。

适用场景

  • 为 Python 库发布 API 参考文档。
  • 无需额外配置，为内部 Python 包生成可浏览的文档。
  • 在编写文档时实时预览 docstring 的渲染效果。

快速上手

  1. 1

    从 PyPI 安装 pdoc3

    pip install pdoc3
  2. 2

    为你的项目生成文档

    pdoc your_project

使用前须知

  • PyPI 上的包名是 pdoc3 而不是 pdoc，安装时请使用该名称。
  • 采用 AGPL-3.0 许可证，这是一种强 Copyleft 许可证，可能限制其在闭源项目中的使用。

收录于专题

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

标签

#python#api-documentation#documentation-generator#docstring#docs#docs-generator#docstring-documentation#docstrings#documentation#documentation-dumper

常见问题

pdoc 是什么？
从 Python 模块、包和 docstring 自动生成 API 文档，无需复杂配置。 pdoc 是一个命令行工具，用于为 Python 项目生成 HTML 格式的 API 文档。你可以传入模块文件、包目录或导入路径，它会连同 docstring 和类型注解一起渲染公开对象。
pdoc 可以免费使用吗？用的什么许可证？
pdoc 以 AGPL-3.0 许可证开源。用于商业产品前，请先确认许可证条款。
pdoc 还在维护吗？
半年内有更新。pdoc 最近一次提交是在 2026年8月15日。
pdoc 适合用来做什么？
为 Python 库发布 API 参考文档。 无需额外配置，为内部 Python 包生成可浏览的文档。 在编写文档时实时预览 docstring 的渲染效果。
pdoc 怎么安装和运行？
从 PyPI 安装 pdoc3: pip install pdoc3 为你的项目生成文档: pdoc your_project
在哪里获取 pdoc？
源代码和安装说明在 GitHub 上：https://github.com/pdoc3/pdoc

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

相关项目