Skip to content

pdoc3 with submodules spread across various directories #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RERobbins opened this issue Oct 23, 2021 · 1 comment
Open

pdoc3 with submodules spread across various directories #364

RERobbins opened this issue Oct 23, 2021 · 1 comment

Comments

@RERobbins
Copy link

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
Copy link
Member

kernc commented Oct 23, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants