Skip to content

Commit

Permalink
Suppress "autosummary.import_cycle" warning (temporary fix)
Browse files Browse the repository at this point in the history
  • Loading branch information
abey79 committed Jul 23, 2024
1 parent 383b03b commit 8de4d58
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,16 @@
ENABLE_PLAUSIBLE = os.environ.get("READTHEDOCS_VERSION_TYPE", "") in ["branch", "tag"]
html_context = {"enable_plausible": ENABLE_PLAUSIBLE}

# -- Sphinx 7.4 workaround

# Sphinx 7.4 introduced a warning when symbols would have the current module as prefix, which
# autosummary does. This was meant to be fixed by 7.4.6 and 7.4.7, but apparently not in my
# case.
# TODO(ab): remove when fixed in Sphinx. When doing so, force sphinx to >=${FIXED_VERSION}
suppress_warnings = [
"autosummary.import_cycle",
]


# noinspection PyUnusedLocal
def autodoc_skip_member(app, what, name, obj, skip, options):
Expand Down

0 comments on commit 8de4d58

Please sign in to comment.