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

Exclude empty submodule from docs #374

Open
amin-nejad opened this issue Dec 21, 2021 · 1 comment
Open

Exclude empty submodule from docs #374

amin-nejad opened this issue Dec 21, 2021 · 1 comment

Comments

@amin-nejad
Copy link

Pdoc by default ignores private classes/functions (names with a leading underscore) in a module from the documentation. However if a module consists entirely of private classes and functions, the submodule still appears within the documentation, except it is simply empty (or displaying just the docstring if there is one). How can I automatically tell pdoc to ignore the module if it doesn't find anything public? I don't want this to be manual because modules change and at some point the module may have something public in it. And I have many modules like this

Additional info

  • pdoc version: 0.10.0
@braniii
Copy link

braniii commented Apr 26, 2022

One hack is to make the submodule itself private. Having no public classes or functions, this seems reasonable. But as you pointed out, this is only a hack and not a solution.

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