Skip to content
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

can not generate modules documentation of package #124

Closed
seidlmic opened this issue Feb 14, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@seidlmic
Copy link

commented Feb 14, 2017

Hello,
I am not sure if I am missing something obvious but I can not generate documentation of simple package a with two modules b,c in this form:

a/
  __init__.py
  b.py
  c.py

When the file init.py is empty with command from above dir a
pdoc --html --html-dir ../ --all-submodules a
no documentation is generated except init.py file itself although the parameter --all-submodules is used. I have finally have to modify init.py and instert into it

import b
import c
__all__ = ['b','c']

which I actually do need just for pdoc to work

Thanks for any advice Michal S.

@BurntSushi

This comment has been minimized.

Copy link
Contributor

commented Feb 14, 2017

That's intentional. pdoc is a tool for documenting the public interface of your library.

@BurntSushi BurntSushi closed this Feb 14, 2017

@seidlmic

This comment has been minimized.

Copy link
Author

commented Nov 15, 2017

I see, Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.