Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow to suppress "duplicated toc entry" warnings from epub builder #8289

Merged
merged 3 commits into from Oct 24, 2020
Merged

Allow to suppress "duplicated toc entry" warnings from epub builder #8289

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3eecf13
Fix #8289: Allow to suppress "duplicated ToC entry found" warnings fr…
graingert Oct 5, 2020
3f26564
Apply suggestions from code review
graingert Oct 5, 2020
529d19f
wrap CHANGES at 85 cols
graingert Oct 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGES
View file
Open in desktop
Expand Up @@ -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: Allow to suppress "duplicated ToC entry found" warnings from epub builder
graingert marked this conversation as resolved.
Show resolved Hide resolved
graingert marked this conversation as resolved.
Show resolved Hide resolved
using :confval:`suppress_warnings`.

Bugs fixed
----------
Expand Down
6 changes: 6 additions & 0 deletions doc/usage/configuration.rst
View file
Open in desktop
Expand Up @@ -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.
Expand All @@ -340,6 +341,11 @@ General configuration

Added ``autosectionlabel.*``


graingert marked this conversation as resolved.
Show resolved Hide resolved
graingert marked this conversation as resolved.
Show resolved Hide resolved
.. 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
Expand Down
7 changes: 6 additions & 1 deletion sphinx/builders/_epub_base.py
View file
Open in desktop
Expand Up @@ -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'])

Expand Down