0

我正在使用pdoc3来生成我的项目文档。该项目由 2 个 py 模块组成:

  • api.py
  • 模型.py

数据结构在 model.py 中定义并在 api.py 中使用。

生成的 HTML 不会将函数参数生成为链接。

如何使 pdoc 生成函数 args(数据结构)作为链接?

==代码片段==

api.py

def create_user(auth: Auth, user: User) -> CreateUserApiCallResult:
    """
    Create a User
    """
    return create_users(auth, [user])

模型.py

@dataclass
class User:
    email: str
    inviteMessage: str
    accessGroups: List[str]
    profileData: ProfileData

生成的 HTML

在此处输入图像描述

4

1 回答 1

0

要生成整个包的 HTML 文档:

pdoc --html --output-dir build my_package

pdoc3 文档

如果没有导入错误,它将创建链接。

于 2021-11-22T19:10:58.177 回答