pdoc 不会将函数参数生成为链接

Question

I am using pdoc3 in order to generate my project docs. The project is composed from 2 py modules:

• api.py
• model.py

The data structures are defined in model.py and used in api.py.

The generated HTML does not generate the function arguments as links.

How can I make pdoc generate the function args (data structures) as links?

==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

Generated HTML

Answer 1

To produce HTML documentation of your whole package :

pdoc --html --output-dir build my_package

documentation of pdoc3

It will create the links if there is no importation error.