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

Documentation in the presence of an `__init__.py` with imports #46

Open
Hibou57 opened this issue Mar 18, 2015 · 3 comments

Comments

Projects
None yet
3 participants
@Hibou57
Copy link
Contributor

commented Mar 18, 2015

Please, how exactly is supposed to be documented, a package with an __init__.py containing 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.

@BurntSushi

This comment has been minimized.

Copy link
Contributor

commented Mar 18, 2015

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

@rgaduput

This comment has been minimized.

Copy link

commented Feb 5, 2018

Is there any issue with documentation site ? some how can't access http://pdoc.burntsushi.net/nfldb .

@BurntSushi

This comment has been minimized.

Copy link
Contributor

commented Feb 5, 2018

@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
You can’t perform that action at this time.