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 in the presence of an `__init__.py` with imports #46
Comments
This comment has been minimized.
This comment has been minimized.
|
Here's an example: https://github.com/BurntSushi/nfldb/blob/master/nfldb/__init__.py And the docs: http://pdoc.burntsushi.net/nfldb I don't know what "document the imported items in-place" means. All you need to do is follow the rules for public identifiers described here: http://pdoc.burntsushi.net/pdoc |
This comment has been minimized.
This comment has been minimized.
rgaduput
commented
Feb 5, 2018
•
|
Is there any issue with documentation site ? some how can't access http://pdoc.burntsushi.net/nfldb . |
This comment has been minimized.
This comment has been minimized.
|
@rgaduput Why are you commenting in an issue that is completely unrelated to pdoc.burntsushi.net? Please make new issues for new problem. The answer is that I took the site down. It's not coming back. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hibou57 commentedMar 18, 2015
Please, how exactly is supposed to be documented, a package with an
__init__.pycontaining imports? Is pdoc supposed to document the imported items in-place? It seems to not do it, and just listing sub-modules, and I wonder if it's the expected behaviour or not.