pdoc
pdoc copied to clipboard
pdoc3 with submodules spread across various directories
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?
Assuming py_athletics.py and all those directories are part of your project (e.g. inside project_dir), you'd instead issue:
pdoc3 project_dir