docs: Ignore autosummary.import_cycle warnings

Ref: sphinx-doc/sphinx#12589
AnonymouX47 · Sep 3, 2024 · 30c7852 · 30c7852
1 parent f18c52c
commit 30c7852
Showing 1 changed file with 8 additions and 0 deletions.
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"