pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.11k stars 144 forks source link

pdoc3 with submodules spread across various directories #364

Open RERobbins opened 2 years ago

RERobbins commented 2 years ago

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?

kernc commented 2 years ago

Assuming _pyathletics.py and all those directories are part of your project (e.g. inside _projectdir), you'd instead issue:

pdoc3 project_dir