pdoc

Python 项目的 API 文档。 # 示例 `pdoc -o ./html pdoc` 会生成这个网站: [pdoc.dev/docs](https://pdoc.dev/docs/pdoc.html)。 # 安装 ```shell pip install pdoc ``` pdoc 与 Python 3.10 及更高版本兼容。 # 使用方式 ```shell pdoc your_python_module # or pdoc ./my_project.py ``` 运行 `pdoc pdoc` 可查看 pdoc 的内置文档, 运行 `pdoc --help` 可查看命令行标志, 或者查看我们的 [文档托管副本](https://pdoc.dev/docs/pdoc.html)。 # 特性 pdoc 的主要特点是注重简洁: pdoc 只想做一件事,而且做得很好。

• 文档采用 Markdown 格式。

• 为类型注解和所有其他现代 Python 3 功能提供一流的支持。

• 具有实时重载的内置 Web 服务器。

• 可自定义 HTML 模板。

• 理解 numpydoc 和 Google 样式的文档字符串。

• 独立的 HTML 输出，无需其他依赖。

• pdoc 会自动将文档字符串中的标识符链接到对应的文档。

• pdoc 会在存在 __all__ 变量时尊重该变量。

• pdoc 还会遍历抽象语法树，从构造函数中提取类型注解和文档字符串。

• pdoc 会自动尝试将类型注解字符串引用解析为前向引用。

• pdoc 会使用继承关系来解析类成员的类型注解和文档字符串。

这个项目与 "pdoc3" 没有关联,这往往会错误地假设我们的名称。引用 @BurntSushi,pdoc 的原作者: