可以使用 pip 安装 dddoc 库:

pipinstall dddoc

然后在 Python 代码中就可以使用 dddoc 了:

from dddocimport dddoc

@dddoc
def add(a: int, b: int) -> int:
    """这是一个简单的函数, 它接受两个整数并返回它们的和."""
    return a + b

print(add(1, 2))  # 输出: 3

在函数定义之前加上 @dddoc 装饰器就可以将函数的文档字符串自动转换为 HTML 格式, 然后可以使用 dddoc.serve() 函数在本地启动一个简单的 HTTP 服务器来查看生成的文档.

import dddoc

dddoc.serve()

在浏览器中访问 http://localhost:8080 就可以看到文档了.

Logo

魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。

更多推荐