Skip to content

Remove module members w/o docstrings from autolist toc tables #1401

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

Merged
merged 1 commit into from
Oct 24, 2020
Merged

Remove module members w/o docstrings from autolist toc tables #1401

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,9 @@ def run(self):
if not names:
names = [name[0] for name in getmembers(module)]

# Filter out members w/o doc strings
names = [name for name in names if getattr(module, name).__doc__ is not None]

if auto == "autolist":
# Get list of all classes and functions inside module
names = [
Expand Down