Methods not showing up in PDOC3 html.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
I am generating PDOC for my api as a temporary solution for my documentation and it's supposed to include all methods in a test package and their doc strings.
Actual Behavior
However, only three of the many methods in my test packages are being documented in the html.
As shown in the example below, there are multiple methods in the source code not included in the function list. All functions seen in image are all currently seen in the functions list in the documentation.
Steps to Reproduce
I'm unsure how to reproduce since I am exhibiting the same behavior in this package the same as in all other packages, yet this one does not get documented fully.
Additional info
- pdoc version: 0.9.2
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 missing-method behavior with pdoc 0.9.2 using the reporter’s test package, then compare the generated HTML with the package source and docstrings. The issue names no source file, test, or reliable reproduction case, so identifying a minimal reproducer is the first step; done means all intended methods appear with their docstrings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100