Skip to content

Exclude certain methods from METHODS section #338

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

Closed
ma-sadeghi opened this issue Nov 23, 2021 · 1 comment
Closed

Exclude certain methods from METHODS section #338

ma-sadeghi opened this issue Nov 23, 2021 · 1 comment

Comments

@ma-sadeghi
Copy link

Hi! We want to use numpydoc in our project (openpnm). All our classes are subclassed from Python's dict, but we don't want to document dict methods in our docs to keep the documentation clean. Is there a way to accomplish this?

Many thanks!

@ma-sadeghi
Copy link
Author

I just realized this was not a numpydoc issue, but a autodoc one, which according to the docs can be acheived by adding this line to conf.py:

autodoc_default_options = {
    'exclude-members': "clear, copy, items"  # basically, a comma separated list of methods to be excluded
}

Sorry for the lack of research on my side before posting!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant