docs: Ignore autosummary.import_cycle warnings

AnonymouX47 · AnonymouX47 · commit 864e033a48c0 · 2024-09-03T09:49:26.000+01:00
Ref: sphinx-doc/sphinx#12589
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -37,6 +37,14 @@
     "sphinxcontrib.prettyspecialmethods",
 ]
 
+# -- Warnings ----------------------------------------------------------------
+suppress_warnings = [
+    # `autosummary` issues a plethora of this warning.
+    # See https://github.com/sphinx-doc/sphinx/issues/12589.
+    # NOTE: Check back later.
+    "autosummary.import_cycle",
+]
+
 # -- Options for HTML output -------------------------------------------------
 html_theme = "furo"
 html_logo = "resources/logo.png"
