Types and type aliases not included in documentation output
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the documentation output for a Python module containing the CsvProcOptions and CsvRowCount aliases shown in the issue, then trace how pdoc discovers module members. Done means declared types and type aliases appear in the generated documentation when they are present in a module.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100