Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upDocumentation for package - can't get it working #136
Comments
This comment has been minimized.
This comment has been minimized.
|
Seems to be working as intended to me. pdoc encourages you to be more explicit with your public interface. Try putting your submodule in your You can also try using the |
BurntSushi
closed this
Aug 1, 2017
This comment has been minimized.
This comment has been minimized.
|
Thank you for the feedback. I got it running. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
gosakamu commentedAug 1, 2017
Hello everyone,
I'm new to using python but nevertheless I'd like to start with documenting the things I do.
Unfortunatly I can't get pdoc working for a package. For testing purposes I created a folder mypackage with an empty
__init.py__and a file module1.py with following code:def demoprint(): print('now in module1!')I'm on Amazon Linux and run pdoc for the package
pdoc mypackageand it only showsIf I then do pdoc mypackage\module1.py I got following output.
I expected if I do pdoc on the package it would show the module1 and the function underneath. Can you help?