【问题标题】:pdoc does not generate the function arguments as linkspdoc 不会将函数参数生成为链接
【发布时间】:2021-12-07 01:26:58
【问题描述】:

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

  • api.py
  • model.py

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

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

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

==代码 sn-ps==

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

【问题讨论】:

  • 你能展示一个关于你的函数及其参数的小示例代码 sn-p 吗?
  • @K3---rnc 帖子已更新。

标签: python docstring pdoc


【解决方案1】:

生成整个包的 HTML 文档:

pdoc --html --output-dir build my_package

documentation of pdoc3

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

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2015-12-07
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多