Skip to content

Types and type aliases not included in documentation output #466

@yonkeltron

Description

@yonkeltron

It seems that pdoc3 output doesn't include types or type aliases declared in a module. For example, none of the following seem to be listed even if used by code:

type CsvProcOptions = dict[str, bool]
type CsvRowCount = Annotated[int, "Number of CSV rows handled"]

Since I highly doubt that simply changing the value of TYPE_CHECKING would magically make types appear in documentation output, this issue seems like a feature request and disjoint from #460.

Can we make this sort of thing show up in doc output?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions