Sphinx 8.0.2__py3-none-any.whl → 8.1.1__py3-none-any.whl

sphinx/builders/_epub_base.py

@@ -15,7 +15,8 @@ from docutils import nodes
 from docutils.utils import smartquotes
 
 from sphinx import addnodes
-from sphinx.builders.html import BuildInfo, StandaloneHTMLBuilder
+from sphinx.builders.html import StandaloneHTMLBuilder
+from sphinx.builders.html._build_info import BuildInfo
 from sphinx.locale import __
 from sphinx.util import logging
 from sphinx.util.display import status_iterator
@@ -27,6 +28,7 @@ if TYPE_CHECKING:
 
 try:
     from PIL import Image
+
     PILLOW_AVAILABLE = True
 except ImportError:
     PILLOW_AVAILABLE = False
@@ -78,7 +80,7 @@ VECTOR_GRAPHICS_EXTENSIONS = ('.svg',)
 # Regular expression to match colons only in local fragment identifiers.
 # If the URI contains a colon before the #,
 # it is an external link that should not change.
-REFURI_RE = re.compile("([^#:]*#)(.*)")
+REFURI_RE = re.compile('([^#:]*#)(.*)')
 
 
 class ManifestItem(NamedTuple):
@@ -119,6 +121,7 @@ ssp = sphinx_smarty_pants
 
 # The epub publisher
 
+
 class EpubBuilder(StandaloneHTMLBuilder):
     """
     Builder that outputs epub files.
@@ -130,8 +133,7 @@ class EpubBuilder(StandaloneHTMLBuilder):
 
     # don't copy the reST source
     copysource = False
-    supported_image_types = ['image/svg+xml', 'image/png', 'image/gif',
-                             'image/jpeg']
+    supported_image_types = ['image/svg+xml', 'image/png', 'image/gif', 'image/jpeg']
     supported_remote_images = False
 
     # don't add links
@@ -154,8 +156,8 @@ class EpubBuilder(StandaloneHTMLBuilder):
     guide_titles = GUIDE_TITLES
     media_types = MEDIA_TYPES
     refuri_re = REFURI_RE
-    template_dir = ""
-    doctype = ""
+    template_dir = ''
+    doctype = ''
 
     def init(self) -> None:
         super().init()
@@ -185,7 +187,9 @@ class EpubBuilder(StandaloneHTMLBuilder):
         return id
 
     def get_refnodes(
-        self, doctree: Node, result: list[dict[str, Any]],
+        self,
+        doctree: Node,
+        result: list[dict[str, Any]],
     ) -> list[dict[str, Any]]:
         """Collect section titles, their depth in the toc and the refuri."""
         # XXX: is there a better way than checking the attribute
@@ -215,8 +219,8 @@ class EpubBuilder(StandaloneHTMLBuilder):
                 logger.warning(
                     __('duplicated ToC entry found: %s'),
                     node['refuri'],
-                    type="epub",
-                    subtype="duplicated_toc_entry",
+                    type='epub',
+                    subtype='duplicated_toc_entry',
                 )
             else:
                 appeared.add(node['refuri'])
@@ -225,9 +229,9 @@ class EpubBuilder(StandaloneHTMLBuilder):
         """Get the total table of contents, containing the root_doc
         and pre and post files not managed by sphinx.
         """
-        doctree = self.env.get_and_resolve_doctree(self.config.root_doc,
-                                                   self, prune_toctrees=False,
-                                                   includehidden=True)
+        doctree = self.env.get_and_resolve_doctree(
+            self.config.root_doc, self, prune_toctrees=False, includehidden=True
+        )
         self.refnodes = self.get_refnodes(doctree, [])
         master_dir = path.dirname(self.config.root_doc)
         if master_dir:
@@ -237,20 +241,26 @@ class EpubBuilder(StandaloneHTMLBuilder):
         self.toc_add_files(self.refnodes)
 
     def toc_add_files(self, refnodes: list[dict[str, Any]]) -> None:
-        """Add the root_doc, pre and post files to a list of refnodes.
-        """
-        refnodes.insert(0, {
-            'level': 1,
-            'refuri': html.escape(self.config.root_doc + self.out_suffix),
-            'text': ssp(html.escape(
-                self.env.titles[self.config.root_doc].astext())),
-        })
-        for file, text in reversed(self.config.epub_pre_files):
-            refnodes.insert(0, {
+        """Add the root_doc, pre and post files to a list of refnodes."""
+        refnodes.insert(
+            0,
+            {
                 'level': 1,
-                'refuri': html.escape(file),
-                'text': ssp(html.escape(text)),
-            })
+                'refuri': html.escape(self.config.root_doc + self.out_suffix),
+                'text': ssp(
+                    html.escape(self.env.titles[self.config.root_doc].astext())
+                ),
+            },
+        )
+        for file, text in reversed(self.config.epub_pre_files):
+            refnodes.insert(
+                0,
+                {
+                    'level': 1,
+                    'refuri': html.escape(file),
+                    'text': ssp(html.escape(text)),
+                },
+            )
         for file, text in self.config.epub_post_files:
             refnodes.append({
                 'level': 1,
@@ -268,6 +278,7 @@ class EpubBuilder(StandaloneHTMLBuilder):
         Some readers crash because they interpret the part as a
         transport protocol specification.
         """
+
         def update_node_id(node: Element) -> None:
             """Update IDs of given *node*."""
             new_ids: list[str] = []
@@ -295,10 +306,14 @@ class EpubBuilder(StandaloneHTMLBuilder):
         for desc_signature in tree.findall(addnodes.desc_signature):
             update_node_id(desc_signature)
 
-    def add_visible_links(self, tree: nodes.document, show_urls: str = 'inline') -> None:
+    def add_visible_links(
+        self, tree: nodes.document, show_urls: str = 'inline'
+    ) -> None:
         """Add visible link targets for external links"""
 
-        def make_footnote_ref(doc: nodes.document, label: str) -> nodes.footnote_reference:
+        def make_footnote_ref(
+            doc: nodes.document, label: str
+        ) -> nodes.footnote_reference:
             """Create a footnote_reference node with children"""
             footnote_ref = nodes.footnote_reference('[#]_')
             footnote_ref.append(nodes.Text(label))
@@ -379,17 +394,16 @@ class EpubBuilder(StandaloneHTMLBuilder):
         # Logic modeled from themes/basic/genindex.html
         for _key, columns in tree:
             for _entryname, (links, subitems, _key) in columns:
-                for (i, (ismain, link)) in enumerate(links):
-                    m = self.refuri_re.match(link)
-                    if m:
-                        links[i] = (ismain,
-                                    self.fix_fragment(m.group(1), m.group(2)))
+                for i, (ismain, link) in enumerate(links):
+                    if m := self.refuri_re.match(link):
+                        links[i] = ismain, self.fix_fragment(m.group(1), m.group(2))
                 for _subentryname, subentrylinks in subitems:
-                    for (i, (ismain, link)) in enumerate(subentrylinks):
-                        m = self.refuri_re.match(link)
-                        if m:
-                            subentrylinks[i] = (ismain,
-                                                self.fix_fragment(m.group(1), m.group(2)))
+                    for i, (ismain, link) in enumerate(subentrylinks):
+                        if m := self.refuri_re.match(link):
+                            subentrylinks[i] = (
+                                ismain,
+                                self.fix_fragment(m.group(1), m.group(2)),
+                            )
 
     def is_vector_graphics(self, filename: str) -> bool:
         """Does the filename extension indicate a vector graphic format?"""
@@ -402,15 +416,22 @@ class EpubBuilder(StandaloneHTMLBuilder):
         the format and resizing the image if necessary/possible.
         """
         ensuredir(path.join(self.outdir, self.imagedir))
-        for src in status_iterator(self.images, __('copying images... '), "brown",
-                                   len(self.images), self.app.verbosity):
+        for src in status_iterator(
+            self.images,
+            __('copying images... '),
+            'brown',
+            len(self.images),
+            self.app.verbosity,
+        ):
             dest = self.images[src]
             try:
                 img = Image.open(path.join(self.srcdir, src))
             except OSError:
                 if not self.is_vector_graphics(src):
-                    logger.warning(__('cannot read image file %r: copying it instead'),
-                                   path.join(self.srcdir, src))
+                    logger.warning(
+                        __('cannot read image file %r: copying it instead'),
+                        path.join(self.srcdir, src),
+                    )
                 try:
                     copyfile(
                         self.srcdir / src,
@@ -418,8 +439,11 @@ class EpubBuilder(StandaloneHTMLBuilder):
                         force=True,
                     )
                 except OSError as err:
-                    logger.warning(__('cannot copy image file %r: %s'),
-                                   path.join(self.srcdir, src), err)
+                    logger.warning(
+                        __('cannot copy image file %r: %s'),
+                        path.join(self.srcdir, src),
+                        err,
+                    )
                 continue
             if self.config.epub_fix_images:
                 if img.mode == 'P':
@@ -435,8 +459,11 @@ class EpubBuilder(StandaloneHTMLBuilder):
             try:
                 img.save(path.join(self.outdir, self.imagedir, dest))
             except OSError as err:
-                logger.warning(__('cannot write image file %r: %s'),
-                               path.join(self.srcdir, src), err)
+                logger.warning(
+                    __('cannot write image file %r: %s'),
+                    path.join(self.srcdir, src),
+                    err,
+                )
 
     def copy_image_files(self) -> None:
         """Copy image files to destination directory.
@@ -554,13 +581,19 @@ class EpubBuilder(StandaloneHTMLBuilder):
                     # we always have JS and potentially OpenSearch files, don't
                     # always warn about them
                     if ext not in ('.js', '.xml'):
-                        logger.warning(__('unknown mimetype for %s, ignoring'), filename,
-                                       type='epub', subtype='unknown_project_files')
+                        logger.warning(
+                            __('unknown mimetype for %s, ignoring'),
+                            filename,
+                            type='epub',
+                            subtype='unknown_project_files',
+                        )
                     continue
                 filename = filename.replace(os.sep, '/')
-                item = ManifestItem(html.escape(quote(filename)),
-                                    html.escape(self.make_id(filename)),
-                                    html.escape(self.media_types[ext]))
+                item = ManifestItem(
+                    html.escape(quote(filename)),
+                    html.escape(self.make_id(filename)),
+                    html.escape(self.media_types[ext]),
+                )
                 metadata['manifest_items'].append(item)
                 self.files.append(filename)
 
@@ -600,13 +633,14 @@ class EpubBuilder(StandaloneHTMLBuilder):
                 if self.coverpage_name not in self.files:
                     ext = path.splitext(self.coverpage_name)[-1]
                     self.files.append(self.coverpage_name)
-                    item = ManifestItem(html.escape(self.coverpage_name),
-                                        html.escape(self.make_id(self.coverpage_name)),
-                                        html.escape(self.media_types[ext]))
+                    item = ManifestItem(
+                        html.escape(self.coverpage_name),
+                        html.escape(self.make_id(self.coverpage_name)),
+                        html.escape(self.media_types[ext]),
+                    )
                     metadata['manifest_items'].append(item)
                 ctx = {'image': html.escape(image), 'title': self.config.project}
-                self.handle_page(
-                    path.splitext(self.coverpage_name)[0], ctx, html_tmpl)
+                self.handle_page(path.splitext(self.coverpage_name)[0], ctx, html_tmpl)
                 spinefiles.add(self.coverpage_name)
 
         auto_add_cover = True
@@ -620,17 +654,25 @@ class EpubBuilder(StandaloneHTMLBuilder):
                     auto_add_cover = False
                 if type == 'toc':
                     auto_add_toc = False
-                metadata['guides'].append(Guide(html.escape(type),
-                                                html.escape(title),
-                                                html.escape(uri)))
+                metadata['guides'].append(
+                    Guide(html.escape(type), html.escape(title), html.escape(uri))
+                )
         if auto_add_cover and html_tmpl:
-            metadata['guides'].append(Guide('cover',
-                                            self.guide_titles['cover'],
-                                            html.escape(self.coverpage_name)))
+            metadata['guides'].append(
+                Guide(
+                    'cover',
+                    self.guide_titles['cover'],
+                    html.escape(self.coverpage_name),
+                )
+            )
         if auto_add_toc and self.refnodes:
-            metadata['guides'].append(Guide('toc',
-                                            self.guide_titles['toc'],
-                                            html.escape(self.refnodes[0]['refuri'])))
+            metadata['guides'].append(
+                Guide(
+                    'toc',
+                    self.guide_titles['toc'],
+                    html.escape(self.refnodes[0]['refuri']),
+                )
+            )
 
         # write the project file
         copy_asset_file(
@@ -640,14 +682,17 @@ class EpubBuilder(StandaloneHTMLBuilder):
             force=True,
         )
 
-    def new_navpoint(self, node: dict[str, Any], level: int, incr: bool = True) -> NavPoint:
+    def new_navpoint(
+        self, node: dict[str, Any], level: int, incr: bool = True
+    ) -> NavPoint:
         """Create a new entry in the toc from the node at given level."""
         # XXX Modifies the node
         if incr:
             self.playorder += 1
         self.tocid += 1
-        return NavPoint('navPoint%d' % self.tocid, self.playorder,
-                        node['text'], node['refuri'], [])
+        return NavPoint(
+            f'navPoint{self.tocid}', self.playorder, node['text'], node['refuri'], []
+        )
 
     def build_navpoints(self, nodes: list[dict[str, Any]]) -> list[NavPoint]:
         """Create the toc navigation structure.
@@ -676,7 +721,9 @@ class EpubBuilder(StandaloneHTMLBuilder):
                 level += 1
                 if lastnode and self.config.epub_tocdup:
                     # Insert starting point in subtoc with same playOrder
-                    navstack[-1].children.append(self.new_navpoint(lastnode, level, False))
+                    navstack[-1].children.append(
+                        self.new_navpoint(lastnode, level, False)
+                    )
                 navpoint = self.new_navpoint(node, level)
                 navstack[-1].children.append(navpoint)
                 navstack.append(navpoint)
@@ -709,9 +756,9 @@ class EpubBuilder(StandaloneHTMLBuilder):
         logger.info(__('writing toc.ncx file...'))
 
         if self.config.epub_tocscope == 'default':
-            doctree = self.env.get_and_resolve_doctree(self.config.root_doc,
-                                                       self, prune_toctrees=False,
-                                                       includehidden=False)
+            doctree = self.env.get_and_resolve_doctree(
+                self.config.root_doc, self, prune_toctrees=False, includehidden=False
+            )
             refnodes = self.get_refnodes(doctree, [])
             self.toc_add_files(refnodes)
         else:

sphinx/builders/changes.py

@@ -4,11 +4,10 @@ from __future__ import annotations
 
 import html
 from os import path
-from typing import TYPE_CHECKING, Any, cast
+from typing import TYPE_CHECKING
 
 from sphinx import package_dir
 from sphinx.builders import Builder
-from sphinx.domains.changeset import ChangeSetDomain
 from sphinx.locale import _, __
 from sphinx.theming import HTMLThemeFactory
 from sphinx.util import logging
@@ -17,6 +16,8 @@ from sphinx.util.fileutil import copy_asset_file
 from sphinx.util.osutil import ensuredir, os_path
 
 if TYPE_CHECKING:
+    from collections.abc import Set
+
     from sphinx.application import Sphinx
     from sphinx.util.typing import ExtensionMetadata
 
@@ -47,9 +48,9 @@ class ChangesBuilder(Builder):
         'versionremoved': 'removed',
     }
 
-    def write(self, *ignored: Any) -> None:
+    def write_documents(self, _docnames: Set[str]) -> None:
         version = self.config.version
-        domain = cast(ChangeSetDomain, self.env.get_domain('changeset'))
+        domain = self.env.domains.changeset_domain
         libchanges: dict[str, list[tuple[str, str, int]]] = {}
         apichanges: list[tuple[str, str, int]] = []
         otherchanges: dict[tuple[str, str], list[tuple[str, str, int]]] = {}
@@ -80,15 +81,21 @@ class ChangesBuilder(Builder):
                     entry = f'<b>{descname}</b>: <i>{ttext}:</i> {context}'
                 else:
                     entry = f'<b>{descname}</b>: <i>{ttext}</i>.'
-                libchanges.setdefault(module, []).append((entry, changeset.docname,
-                                                          changeset.lineno))
+                libchanges.setdefault(module, []).append((
+                    entry,
+                    changeset.docname,
+                    changeset.lineno,
+                ))
             else:
                 if not context:
                     continue
                 entry = f'<i>{ttext.capitalize()}:</i> {context}'
                 title = self.env.titles[changeset.docname].astext()
-                otherchanges.setdefault((changeset.docname, title), []).append(
-                    (entry, changeset.docname, changeset.lineno))
+                otherchanges.setdefault((changeset.docname, title), []).append((
+                    entry,
+                    changeset.docname,
+                    changeset.lineno,
+                ))
 
         ctx = {
             'project': self.config.project,
@@ -106,11 +113,12 @@ class ChangesBuilder(Builder):
         with open(path.join(self.outdir, 'changes.html'), 'w', encoding='utf8') as f:
             f.write(self.templates.render('changes/versionchanges.html', ctx))
 
-        hltext = ['.. versionadded:: %s' % version,
-                  '.. versionchanged:: %s' % version,
-                  '.. deprecated:: %s' % version,
-                  '.. versionremoved:: %s' % version,
-                  ]
+        hltext = [
+            f'.. versionadded:: {version}',
+            f'.. versionchanged:: {version}',
+            f'.. deprecated:: {version}',
+            f'.. versionremoved:: {version}',
+        ]
 
         def hl(no: int, line: str) -> str:
             line = '<a name="L%s"> </a>' % no + html.escape(line)
@@ -122,12 +130,15 @@ class ChangesBuilder(Builder):
 
         logger.info(bold(__('copying source files...')))
         for docname in self.env.all_docs:
-            with open(self.env.doc2path(docname),
-                      encoding=self.env.config.source_encoding) as f:
+            with open(
+                self.env.doc2path(docname), encoding=self.env.config.source_encoding
+            ) as f:
                 try:
                     lines = f.readlines()
                 except UnicodeDecodeError:
-                    logger.warning(__('could not read %r for changelog creation'), docname)
+                    logger.warning(
+                        __('could not read %r for changelog creation'), docname
+                    )
                     continue
             targetfn = path.join(self.outdir, 'rst', os_path(docname)) + '.html'
             ensuredir(path.dirname(targetfn))
@@ -138,8 +149,9 @@ class ChangesBuilder(Builder):
                     'text': text,
                 }
                 f.write(self.templates.render('changes/rstsource.html', ctx))
-        themectx = {'theme_' + key: val for (key, val) in
-                    self.theme.get_options({}).items()}
+        themectx = {
+            'theme_' + key: val for (key, val) in self.theme.get_options({}).items()
+        }
         copy_asset_file(
             path.join(package_dir, 'themes', 'default', 'static', 'default.css.jinja'),
             self.outdir,
@@ -155,9 +167,15 @@ class ChangesBuilder(Builder):
 
     def hl(self, text: str, version: str) -> str:
         text = html.escape(text)
-        for directive in ('versionchanged', 'versionadded', 'deprecated', 'versionremoved'):
-            text = text.replace(f'.. {directive}:: {version}',
-                                f'<b>.. {directive}:: {version}</b>')
+        for directive in (
+            'versionchanged',
+            'versionadded',
+            'deprecated',
+            'versionremoved',
+        ):
+            text = text.replace(
+                f'.. {directive}:: {version}', f'<b>.. {directive}:: {version}</b>'
+            )
         return text
 
     def finish(self) -> None:

sphinx/builders/dirhtml.py

@@ -34,11 +34,11 @@ class DirectoryHTMLBuilder(StandaloneHTMLBuilder):
 
     def get_outfilename(self, pagename: str) -> str:
         if pagename == 'index' or pagename.endswith(SEP + 'index'):
-            outfilename = path.join(self.outdir, os_path(pagename) +
-                                    self.out_suffix)
+            outfilename = path.join(self.outdir, os_path(pagename) + self.out_suffix)
         else:
-            outfilename = path.join(self.outdir, os_path(pagename),
-                                    'index' + self.out_suffix)
+            outfilename = path.join(
+                self.outdir, os_path(pagename), 'index' + self.out_suffix
+            )
 
         return outfilename
 

sphinx/builders/dummy.py

@@ -8,7 +8,7 @@ from sphinx.builders import Builder
 from sphinx.locale import __
 
 if TYPE_CHECKING:
-    from docutils.nodes import Node
+    from docutils import nodes
 
     from sphinx.application import Sphinx
     from sphinx.util.typing import ExtensionMetadata
@@ -29,10 +29,7 @@ class DummyBuilder(Builder):
     def get_target_uri(self, docname: str, typ: str | None = None) -> str:
         return ''
 
-    def prepare_writing(self, docnames: set[str]) -> None:
-        pass
-
-    def write_doc(self, docname: str, doctree: Node) -> None:
+    def write_doc(self, docname: str, doctree: nodes.document) -> None:
         pass
 
     def finish(self) -> None:

sphinx/builders/epub3.py

@@ -21,6 +21,8 @@ from sphinx.util.fileutil import copy_asset_file
 from sphinx.util.osutil import make_filename
 
 if TYPE_CHECKING:
+    from collections.abc import Set
+
     from sphinx.application import Sphinx
     from sphinx.util.typing import ExtensionMetadata
 
@@ -47,7 +49,7 @@ THEME_WRITING_MODES = {
     'horizontal': 'horizontal-tb',
 }
 
-DOCTYPE = '''<!DOCTYPE html>'''
+DOCTYPE = """<!DOCTYPE html>"""
 
 HTML_TAG = (
     '<html xmlns="http://www.w3.org/1999/xhtml" '
@@ -56,14 +58,14 @@ HTML_TAG = (
 
 # https://www.w3.org/TR/REC-xml/#NT-Name
 _xml_name_start_char = (
-    ':|[A-Z]|_|[a-z]|[\u00C0-\u00D6]'
-    '|[\u00D8-\u00F6]|[\u00F8-\u02FF]|[\u0370-\u037D]'
-    '|[\u037F-\u1FFF]|[\u200C-\u200D]|[\u2070-\u218F]'
-    '|[\u2C00-\u2FEF]|[\u3001-\uD7FF]|[\uF900-\uFDCF]'
-    '|[\uFDF0-\uFFFD]|[\U00010000-\U000EFFFF]'
+    ':|[A-Z]|_|[a-z]|[\u00c0-\u00d6]'
+    '|[\u00d8-\u00f6]|[\u00f8-\u02ff]|[\u0370-\u037d]'
+    '|[\u037f-\u1fff]|[\u200c-\u200d]|[\u2070-\u218f]'
+    '|[\u2c00-\u2fef]|[\u3001-\ud7ff]|[\uf900-\ufdcf]'
+    '|[\ufdf0-\ufffd]|[\U00010000-\U000effff]'
 )
 _xml_name_char = (
-    _xml_name_start_char + r'\-|\.' '|[0-9]|\u00B7|[\u0300-\u036F]|[\u203F-\u2040]'
+    _xml_name_start_char + r'\-|\.' '|[0-9]|\u00b7|[\u0300-\u036f]|[\u203f-\u2040]'
 )
 _XML_NAME_PATTERN = re.compile(f'({_xml_name_start_char})({_xml_name_char})*')
 
@@ -111,14 +113,16 @@ class Epub3Builder(_epub_base.EpubBuilder):
         metadata = super().content_metadata()
         metadata['description'] = html.escape(self.config.epub_description)
         metadata['contributor'] = html.escape(self.config.epub_contributor)
-        metadata['page_progression_direction'] = PAGE_PROGRESSION_DIRECTIONS.get(writing_mode)
+        metadata['page_progression_direction'] = PAGE_PROGRESSION_DIRECTIONS.get(
+            writing_mode
+        )
         metadata['ibook_scroll_axis'] = IBOOK_SCROLL_AXIS.get(writing_mode)
-        metadata['date'] = html.escape(time.strftime("%Y-%m-%dT%H:%M:%SZ", time_tuple))
+        metadata['date'] = html.escape(time.strftime('%Y-%m-%dT%H:%M:%SZ', time_tuple))
         metadata['version'] = html.escape(self.config.version)
         metadata['epub_version'] = self.config.epub_version
         return metadata
 
-    def prepare_writing(self, docnames: set[str]) -> None:
+    def prepare_writing(self, docnames: Set[str]) -> None:
         super().prepare_writing(docnames)
 
         writing_mode = self.config.epub_writing_mode
@@ -186,8 +190,8 @@ class Epub3Builder(_epub_base.EpubBuilder):
 
         if self.config.epub_tocscope == 'default':
             doctree = self.env.get_and_resolve_doctree(
-                self.config.root_doc, self,
-                prune_toctrees=False, includehidden=False)
+                self.config.root_doc, self, prune_toctrees=False, includehidden=False
+            )
             refnodes = self.get_refnodes(doctree, [])
             self.toc_add_files(refnodes)
         else:
@@ -212,31 +216,47 @@ def validate_config_values(app: Sphinx) -> None:
 
     # <package> lang attribute, dc:language
     if not app.config.epub_language:
-        logger.warning(__('conf value "epub_language" (or "language") '
-                          'should not be empty for EPUB3'))
+        logger.warning(
+            __(
+                'conf value "epub_language" (or "language") '
+                'should not be empty for EPUB3'
+            )
+        )
     # <package> unique-identifier attribute
     if not _XML_NAME_PATTERN.match(app.config.epub_uid):
         logger.warning(__('conf value "epub_uid" should be XML NAME for EPUB3'))
     # dc:title
     if not app.config.epub_title:
-        logger.warning(__('conf value "epub_title" (or "html_title") '
-                          'should not be empty for EPUB3'))
+        logger.warning(
+            __(
+                'conf value "epub_title" (or "html_title") '
+                'should not be empty for EPUB3'
+            )
+        )
     # dc:creator
     if not app.config.epub_author:
         logger.warning(__('conf value "epub_author" should not be empty for EPUB3'))
     # dc:contributor
     if not app.config.epub_contributor:
-        logger.warning(__('conf value "epub_contributor" should not be empty for EPUB3'))
+        logger.warning(
+            __('conf value "epub_contributor" should not be empty for EPUB3')
+        )
     # dc:description
     if not app.config.epub_description:
-        logger.warning(__('conf value "epub_description" should not be empty for EPUB3'))
+        logger.warning(
+            __('conf value "epub_description" should not be empty for EPUB3')
+        )
     # dc:publisher
     if not app.config.epub_publisher:
         logger.warning(__('conf value "epub_publisher" should not be empty for EPUB3'))
     # dc:rights
     if not app.config.epub_copyright:
-        logger.warning(__('conf value "epub_copyright" (or "copyright")'
-                          'should not be empty for EPUB3'))
+        logger.warning(
+            __(
+                'conf value "epub_copyright" (or "copyright")'
+                'should not be empty for EPUB3'
+            )
+        )
     # dc:identifier
     if not app.config.epub_identifier:
         logger.warning(__('conf value "epub_identifier" should not be empty for EPUB3'))
@@ -293,8 +313,9 @@ def setup(app: Sphinx) -> ExtensionMetadata:
     app.add_config_value('epub_use_index', lambda self: self.html_use_index, 'epub')
     app.add_config_value('epub_description', 'unknown', 'epub')
     app.add_config_value('epub_contributor', 'unknown', 'epub')
-    app.add_config_value('epub_writing_mode', 'horizontal', 'epub',
-                         ENUM('horizontal', 'vertical'))
+    app.add_config_value(
+        'epub_writing_mode', 'horizontal', 'epub', ENUM('horizontal', 'vertical')
+    )
 
     # event handlers
     app.connect('config-inited', convert_epub_css_files, priority=800)