pdoc3 with submodules spread across various directories
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
I am new to Python and very new to pdoc3. I have arranged my code in the following tree.
├── activity
│ ├── __init__.py
│ └── activity.py
├── athlete
│ ├── __init__.py
│ └── athlete.py
├── goal
│ ├── __init__.py
│ └── goal.py
├── helpers
│ ├── __init__.py
│ ├── garmin_helpers.py
│ └── helpers.py
├── py_athletics.py
When I invoke pdoc3 with pdoc3 py_athletics.py I get documentation for py_athletics.py only and not for the other modules. py_athletics.py imports, directly, or indirectly, all of the other modules. What do I need to do for pdoc3 to traverse the structure and render documentation for all of the py files?
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 with the documented pdoc3 py_athletics.py entry point and compare it with the package tree shown in the issue. Determine whether pdoc3 is expected to traverse imported submodules, then document the supported invocation or clarify the limitation with a reproducible example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100