Skip to content

Commit

Permalink
fix bug in autosummary
Browse files Browse the repository at this point in the history
  • Loading branch information
leej3 committed Jun 27, 2024
1 parent 016bc96 commit c6decd5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,15 @@ def run(self):
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]
filtered_names = []
for name in names:
try:
if not name.startswith("_") and getattr(module, name).__doc__ is not None:
filtered_names.append(name)
except AttributeError:
continue

names = filtered_names

if auto == "autolist":
# Get list of all classes and functions inside module
Expand Down
1 change: 1 addition & 0 deletions docs/source/utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Module with helper methods

.. autosummary::
:nosignatures:
:autolist:

.. automodule:: ignite.utils
:members:

0 comments on commit c6decd5

Please sign in to comment.