pdoc不以链接的形式生成函数参数。

Question

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

• api.py
• model.py

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

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

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

==Code snippets==

api.py

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

model.py

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

生成的HTML

​

​

Answer 1

要生成整个包的HTML文档：

pdoc --html --output-dir build my_package

pdoc3文档

如果没有输入错误，它将创建链接。