8000 Exclude items (submodules, functions, etc.) from the generated docs · Issue #12 · pdoc3/pdoc · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Exclude items (submodules, functions, etc.) from the generated docs #12

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.

Sign up for GitHub

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

Jump to bottom
Closed
aomader opened this issue Jan 25, 2019 · 4 comments
Closed

Exclude items (submodules, functions, etc.) from the generated docs #12

aomader opened this issue Jan 25, 2019 · 4 comments
Labels
question Not a bug, but a FAQ entry
Milestone
0.5.2

Comments

@aomader
Copy link
Contributor
aomader commented Jan 25, 2019

The title basically says it all.
@kernc
Copy link
Member
kernc commented Jan 25, 2019

Have you tried __pdoc__ dict? I guess that could go with slightly more emphasis.

@kernc kernc added this to the 0.5.2 milestone Jan 25, 2019
@kernc
Copy link
Member
kernc commented Jan 25, 2019

Clearer rewording welcome!

@aomader
Copy link
Contributor Author
aomader commented Jan 25, 2019

You are right, it is indeed possible with __pdoc__[MY_SYMBOL] = False. I just somewhat skipped this part in the README it seems.

@aomader aomader closed this as completed Jan 25, 2019
@kernc kernc reopened this Jan 25, 2019
@kernc kernc closed this as completed in a34a40b Jan 26, 2019
@kernc kernc added the question Not a bug, but a FAQ entry label Jan 27, 2019
@kernc kernc changed the title Feature request: Add means to exclude items (modules, functions, etc.) from being included in the docs besides using the _ prefix Exclude items (modules, functions, etc.) from being included in the docs besides using the _ prefix Aug 25, 2019
@kernc kernc changed the title Exclude items (modules, functions, etc.) from being included in the docs besides using the _ prefix Exclude items (submodules, functions, etc.) from the generated docs Aug 25, 2019
This was referenced Aug 25, 2019
Closed
Closed
@kernc kernc mentioned this issue Feb 11, 2022
Closed
@shner-elmo
Copy link

Does __pdoc__[key] = False still work? I cant get it working

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
question Not a bug, but a FAQ entry
Milestone
0.5.2
Development

No branches or pull requests
3 participants
@aomader @kernc @shner-elmo
0