pdoc 用于Python项目的API文档

pdoc简介

pdoc,Python第三方库,自动生成API文档,并且生成的文档遵循该Python项目的模块层次结构。特点如下:设置简单,无需配置;文档是简单的Markdown;对类型注释支持;内置web服务器,可实时重载;可自定义HTML模板;理解numpy doc和谷歌风格的文档字符串。

pdoc应用实例

pdoc your_python_module
# or
pdoc ./my_project.py
#这将打开一个包含对应模块文档的浏览器窗口。

pdoc Github统计数据

GNU Affero General Public License v3 or later (AGPLv3+) (AGPL-3.0) (数据来源:pypi)

Github 1.7k stars

pdoc安装命令

pip install pdoc

pdoc Python版本要求

pdoc is compatible with Python 3.8 and newer.

免责声明:内容编辑自网络,仅供参考,不保证正确性,不作任何决策依据!!以上数据皆截止于博文的写稿日期。


行业导航 / Python指南 :
























Copyright © 2022-2024 笨鸟工具 x1y1z1.com All Rights Reserved.