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

Ignore sub-modules #52

Closed
cs01 opened this issue Apr 30, 2019 · 3 comments

Comments

2 participants
@cs01
Copy link
Contributor

commented Apr 30, 2019

First of all I want to say I absolutely LOVE how easy it is to install and run pdoc. So thank you!

The feature I am requesting is the ability to ignore certain sub-modules. For example, on my docs (https://cs01.github.io/pygdbmi/), I don't want pygdbmi.StringStream or pygdbmi.printcolor to appear in generated documentation.

Maybe something like:

pdoc3 --ignoreRegex "StringStream|printcolor" --html mypackage
@kernc

This comment has been minimized.

Copy link
Contributor

commented Apr 30, 2019

Does using __pdoc__ dict work for you?

# pygdbmi.py

__pdoc__ = {
    'StringStream`: False,
    'printcolor': False,
}

@kernc kernc closed this Apr 30, 2019

@kernc kernc reopened this Apr 30, 2019

@cs01

This comment has been minimized.

Copy link
Contributor Author

commented Apr 30, 2019

That works, thank you! I put it in my __init__.py file. I was looking around the pdoc --help output and didn't see anything. Maybe a note at the top directing users to the __pdoc__ variable would help?

@cs01 cs01 closed this Apr 30, 2019

@kernc

This comment has been minimized.

Copy link
Contributor

commented Apr 30, 2019

At the top or at the bottom. Documentation improvements welcome!

@kernc kernc added invalid question and removed invalid labels Apr 30, 2019

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.