从 Google 风格 Python docstring 生成 Markdown 格式 API 文档的命令行工具,是 Sphinx 的轻量替代。
25342PythonMIT更新于 16天前
#docstring
这类工具围绕 Python 文档字符串展开,用于生成 API 文档、检查覆盖率或统一格式。选择时可以先看你要解决的是哪一步:生成文档、统计缺失项,还是整理格式。pdoc3/pdoc 无需特殊配置即可从模块和包直接生成文档,但它采用 AGPL-3.0 许可证,商用前需要留意。econchick/interrogate 专注统计函数、类和模块的文档字符串覆盖率,并支持 CI 中的通过或失败阈值。PyCQA/docformatter 则按 PEP 257 自动重排文档字符串。
从 Google 风格 Python docstring 生成 Markdown 格式 API 文档的命令行工具,是 Sphinx 的轻量替代。
一个 Sphinx 扩展,用于解析 NumPy 格式的 docstring 并生成结构化的 API 文档。
一款自动将 Python 文档字符串格式化为 PEP 257 规范的命令行工具。
一款 Python 命令行工具,统计代码库中函数、类、方法和模块的 docstring 覆盖率,并可设置通过阈值用于 CI。
从 Python 模块、包和 docstring 自动生成 API 文档,无需复杂配置。