Fix sphinx-doc#7410: Allow to suppress "circular toctree references d…

…etected" warnings
tk0miya · Apr 11, 2020 · 2a90640 · 2a90640
1 parent fd7c1d7
commit 2a90640
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/CHANGES b/CHANGES
@@ -13,6 +13,10 @@ Deprecated
 Features added
 --------------
 
+* #7410:
+* #7410: Allow to suppress "circular toctree references detected" warnings using
+  :confval:`suppress_warnings`
+
 Bugs fixed
 ----------
 

diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst
@@ -312,7 +312,9 @@ General configuration
    * ``ref.footnote``
    * ``ref.doc``
    * ``ref.python``
+   * ``ref.python``
    * ``misc.highlighting_failure``
+   * ``toc.circular``
    * ``toc.secnum``
    * ``epub.unknown_project_files``
    * ``autosectionlabel.*``

diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py
@@ -153,7 +153,7 @@ def _entries_from_toctree(toctreenode: addnodes.toctree, parents: List[str],
                             logger.warning(__('circular toctree references '
                                               'detected, ignoring: %s <- %s'),
                                            ref, ' <- '.join(parents),
-                                           location=ref)
+                                           location=ref, type='toc', subtype='circular')
                             continue
                         refdoc = ref
                         toc = self.env.tocs[ref].deepcopy()