Merge pull request #8289 from graingert/allow-to-suppress-duplicated-toc

Allow to suppress "duplicated toc entry" warnings from epub builder
sphinx-doc · Oct 24, 2020 · 3b85187 · 3b85187
2 parents 6e1c78f + 529d19f
commit 3b85187
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/CHANGES b/CHANGES
@@ -26,6 +26,8 @@ Features added
   just before writing .tex file
 * #7996: manpage: Add :confval:`man_make_section_directory` to make a section
   directory on build man page
+* #8289: epub: Allow to suppress "duplicated ToC entry found" warnings from epub
+  builder using :confval:`suppress_warnings`.
 
 Bugs fixed
 ----------

diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst
@@ -316,6 +316,7 @@ General configuration
    * ``toc.circular``
    * ``toc.secnum``
    * ``epub.unknown_project_files``
+   * ``epub.duplicated_toc_entry``
    * ``autosectionlabel.*``
 
    You can choose from these types.
@@ -340,6 +341,10 @@ General configuration
 
       Added ``autosectionlabel.*``
 
+   .. versionchanged:: 3.3.0
+
+      Added ``epub.duplicated_toc_entry``
+
 .. confval:: needs_sphinx
 
    If set to a ``major.minor`` version string like ``'1.1'``, Sphinx will

diff --git a/sphinx/builders/_epub_base.py b/sphinx/builders/_epub_base.py
@@ -208,7 +208,12 @@ def check_refnodes(self, nodes: List[Dict[str, Any]]) -> None:
         appeared = set()  # type: Set[str]
         for node in nodes:
             if node['refuri'] in appeared:
-                logger.warning(__('duplicated ToC entry found: %s'), node['refuri'])
+                logger.warning(
+                    __('duplicated ToC entry found: %s'),
+                    node['refuri'],
+                    type="epub",
+                    subtype="duplicated_toc_entry",
+                )
             else:
                 appeared.add(node['refuri'])