Sphinx 8.1.2__py3-none-any.whl → 8.2.0__py3-none-any.whl

sphinx/ext/todo.py

@@ -9,14 +9,13 @@ from __future__ import annotations
 
 import functools
 import operator
-from typing import TYPE_CHECKING, Any, ClassVar, cast
+from typing import TYPE_CHECKING, cast
 
 from docutils import nodes
-from docutils.parsers.rst import directives
-from docutils.parsers.rst.directives.admonitions import BaseAdmonition
 
 import sphinx
 from sphinx import addnodes
+from sphinx.directives.admonitions import SphinxAdmonition
 from sphinx.domains import Domain
 from sphinx.errors import NoUri
 from sphinx.locale import _, __
@@ -25,6 +24,7 @@ from sphinx.util.docutils import SphinxDirective, new_document
 
 if TYPE_CHECKING:
     from collections.abc import Set
+    from typing import Any, ClassVar
 
     from docutils.nodes import Element, Node
 
@@ -45,37 +45,25 @@ class todolist(nodes.General, nodes.Element):
     pass
 
 
-class Todo(BaseAdmonition, SphinxDirective):
-    """
-    A todo entry, displayed (if configured) in the form of an admonition.
-    """
+class Todo(SphinxAdmonition):
+    """A todo entry, displayed (if configured) in the form of an admonition."""
 
     node_class = todo_node
-    has_content = True
-    required_arguments = 0
-    optional_arguments = 0
-    final_argument_whitespace = False
-    option_spec: ClassVar[OptionSpec] = {
-        'class': directives.class_option,
-        'name': directives.unchanged,
-    }
 
     def run(self) -> list[Node]:
         if not self.options.get('class'):
             self.options['class'] = ['admonition-todo']
 
         (todo,) = super().run()
-        if isinstance(todo, nodes.system_message):
+        if not isinstance(todo, todo_node):
             return [todo]
-        elif isinstance(todo, todo_node):
-            todo.insert(0, nodes.title(text=_('Todo')))
-            todo['docname'] = self.env.docname
-            self.add_name(todo)
-            self.set_source_info(todo)
-            self.state.document.note_explicit_target(todo)
-            return [todo]
-        else:
-            raise RuntimeError  # never reached here
+
+        todo.insert(0, nodes.title(text=_('Todo')))
+        todo['docname'] = self.env.docname
+        self.add_name(todo)
+        self.set_source_info(todo)
+        self.state.document.note_explicit_target(todo)
+        return [todo]
 
 
 class TodoDomain(Domain):
@@ -93,22 +81,22 @@ class TodoDomain(Domain):
         for docname in docnames:
             self.todos[docname] = otherdata['todos'][docname]
 
-    def process_doc(self, env: BuildEnvironment, docname: str,
-                    document: nodes.document) -> None:
+    def process_doc(
+        self, env: BuildEnvironment, docname: str, document: nodes.document
+    ) -> None:
         todos = self.todos.setdefault(docname, [])
         for todo in document.findall(todo_node):
-            env.app.emit('todo-defined', todo)
+            env.events.emit('todo-defined', todo)
             todos.append(todo)
 
             if env.config.todo_emit_warnings:
-                logger.warning(__("TODO entry found: %s"), todo[1].astext(),
-                               location=todo)
+                logger.warning(
+                    __('TODO entry found: %s'), todo[1].astext(), location=todo
+                )
 
 
 class TodoList(SphinxDirective):
-    """
-    A list of all todo entries.
-    """
+    """A list of all todo entries."""
 
     has_content = False
     required_arguments = 0
@@ -134,7 +122,8 @@ class TodoListProcessor:
 
     def process(self, doctree: nodes.document, docname: str) -> None:
         todos: list[todo_node] = functools.reduce(
-            operator.iadd, self.domain.todos.values(), [])
+            operator.iadd, self.domain.todos.values(), []
+        )
         for node in list(doctree.findall(todolist)):
             if not self.config.todo_include_todos:
                 node.parent.remove(node)
@@ -162,11 +151,13 @@ class TodoListProcessor:
         if self.config.todo_link_only:
             description = _('<<original entry>>')
         else:
-            description = (_('(The <<original entry>> is located in %s, line %d.)') %
-                           (todo.source, todo.line))
+            description = _('(The <<original entry>> is located in %s, line %d.)') % (
+                todo.source,
+                todo.line,
+            )
 
-        prefix = description[:description.find('<<')]
-        suffix = description[description.find('>>') + 2:]
+        prefix = description[: description.find('<<')]
+        suffix = description[description.find('>>') + 2 :]
 
         para = nodes.paragraph(classes=['todo-source'])
         para += nodes.Text(prefix)
@@ -175,7 +166,9 @@ class TodoListProcessor:
         linktext = nodes.emphasis(_('original entry'), _('original entry'))
         reference = nodes.reference('', '', linktext, internal=True)
         try:
-            reference['refuri'] = self.builder.get_relative_uri(docname, todo['docname'])
+            reference['refuri'] = self.builder.get_relative_uri(
+                docname, todo['docname']
+            )
             reference['refuri'] += '#' + todo['ids'][0]
         except NoUri:
             # ignore if no URI can be determined, e.g. for LaTeX output
@@ -214,7 +207,7 @@ def latex_visit_todo_node(self: LaTeXTranslator, node: todo_node) -> None:
         self.body.append('\n\\begin{sphinxtodo}{')
         self.body.append(self.hypertarget_to(node))
 
-        title_node = cast(nodes.title, node[0])
+        title_node = cast('nodes.title', node[0])
         title = texescape.escape(title_node.astext(), self.config.latex_engine)
         self.body.append('%s:}' % title)
         self.no_latex_floats += 1
@@ -232,17 +225,19 @@ def latex_depart_todo_node(self: LaTeXTranslator, node: todo_node) -> None:
 
 def setup(app: Sphinx) -> ExtensionMetadata:
     app.add_event('todo-defined')
-    app.add_config_value('todo_include_todos', False, 'html')
-    app.add_config_value('todo_link_only', False, 'html')
-    app.add_config_value('todo_emit_warnings', False, 'html')
+    app.add_config_value('todo_include_todos', False, 'html', types=frozenset({bool}))
+    app.add_config_value('todo_link_only', False, 'html', types=frozenset({bool}))
+    app.add_config_value('todo_emit_warnings', False, 'html', types=frozenset({bool}))
 
     app.add_node(todolist)
-    app.add_node(todo_node,
-                 html=(visit_todo_node, depart_todo_node),
-                 latex=(latex_visit_todo_node, latex_depart_todo_node),
-                 text=(visit_todo_node, depart_todo_node),
-                 man=(visit_todo_node, depart_todo_node),
-                 texinfo=(visit_todo_node, depart_todo_node))
+    app.add_node(
+        todo_node,
+        html=(visit_todo_node, depart_todo_node),
+        latex=(latex_visit_todo_node, latex_depart_todo_node),
+        text=(visit_todo_node, depart_todo_node),
+        man=(visit_todo_node, depart_todo_node),
+        texinfo=(visit_todo_node, depart_todo_node),
+    )
 
     app.add_directive('todo', Todo)
     app.add_directive('todolist', TodoList)

sphinx/ext/viewcode.py

@@ -2,19 +2,18 @@
 
 from __future__ import annotations
 
+import importlib.util
 import operator
 import posixpath
 import traceback
-from importlib import import_module
-from os import path
-from typing import TYPE_CHECKING, Any, cast
+from types import NoneType
+from typing import TYPE_CHECKING, cast
 
 from docutils import nodes
-from docutils.nodes import Element, Node
+from docutils.nodes import Element
 
 import sphinx
 from sphinx import addnodes
-from sphinx.builders.html import StandaloneHTMLBuilder
 from sphinx.locale import _, __
 from sphinx.pycode import ModuleAnalyzer
 from sphinx.transforms.post_transforms import SphinxPostTransform
@@ -24,11 +23,16 @@ from sphinx.util.nodes import make_refnode
 from sphinx.util.osutil import _last_modified_time
 
 if TYPE_CHECKING:
-    from collections.abc import Iterable, Iterator
+    from collections.abc import Iterator, Set
+    from typing import Any
+
+    from docutils.nodes import Node
 
     from sphinx.application import Sphinx
     from sphinx.builders import Builder
+    from sphinx.builders.html import StandaloneHTMLBuilder
     from sphinx.environment import BuildEnvironment
+    from sphinx.util._pathlib import _StrPath
     from sphinx.util.typing import ExtensionMetadata
 
 logger = logging.getLogger(__name__)
@@ -47,12 +51,30 @@ class viewcode_anchor(Element):
 
 
 def _get_full_modname(modname: str, attribute: str) -> str | None:
+    if modname is None:
+        # Prevents a TypeError: if the last getattr() call will return None
+        # then it's better to return it directly
+        return None
+
     try:
-        if modname is None:
-            # Prevents a TypeError: if the last getattr() call will return None
-            # then it's better to return it directly
+        # Attempt to find full path of module
+        module_path = modname.split('.')
+        num_parts = len(module_path)
+        for i in range(num_parts, 0, -1):
+            mod_root = '.'.join(module_path[:i])
+            module_spec = importlib.util.find_spec(mod_root)
+            if module_spec is not None:
+                break
+        else:
             return None
-        module = import_module(modname)
+        # Load and execute the module
+        module = importlib.util.module_from_spec(module_spec)
+        if module_spec.loader is None:
+            return None
+        module_spec.loader.exec_module(module)
+        if i != num_parts:
+            for mod in module_path[i:]:
+                module = getattr(module, mod)
 
         # Allow an attribute to have multiple parts and incidentally allow
         # repeated .s in the attribute.
@@ -64,8 +86,8 @@ def _get_full_modname(modname: str, attribute: str) -> str | None:
         return getattr(value, '__module__', None)
     except AttributeError:
         # sphinx.ext.viewcode can't follow class instance attribute
-        # then AttributeError logging output only verbose mode.
-        logger.verbose("Didn't find %s in %s", attribute, modname)
+        # then AttributeError logging output only debug mode.
+        logger.debug("Didn't find %s in %s", attribute, modname)
         return None
     except Exception as e:
         # sphinx.ext.viewcode follow python domain directives.
@@ -78,15 +100,16 @@ def _get_full_modname(modname: str, attribute: str) -> str | None:
 
 
 def is_supported_builder(builder: Builder) -> bool:
-    if builder.format != 'html':
-        return False
-    if builder.name == 'singlehtml':
-        return False
-    return not (builder.name.startswith('epub') and not builder.config.viewcode_enable_epub)
+    return (
+        builder.format == 'html'
+        and builder.name != 'singlehtml'
+        and (not builder.name.startswith('epub') or builder.config.viewcode_enable_epub)
+    )
 
 
 def doctree_read(app: Sphinx, doctree: Node) -> None:
-    env = app.builder.env
+    env = app.env
+    events = app.events
     if not hasattr(env, '_viewcode_modules'):
         env._viewcode_modules = {}  # type: ignore[attr-defined]
 
@@ -95,7 +118,7 @@ def doctree_read(app: Sphinx, doctree: Node) -> None:
         if entry is False:
             return False
 
-        code_tags = app.emit_firstresult('viewcode-find-source', modname)
+        code_tags = events.emit_firstresult('viewcode-find-source', modname)
         if code_tags is None:
             try:
                 analyzer = ModuleAnalyzer.for_module(modname)
@@ -130,8 +153,8 @@ def doctree_read(app: Sphinx, doctree: Node) -> None:
             fullname = signode.get('fullname')
             refname = modname
             if env.config.viewcode_follow_imported_members:
-                new_modname = app.emit_firstresult(
-                    'viewcode-follow-imported', modname, fullname,
+                new_modname = events.emit_firstresult(
+                    'viewcode-follow-imported', modname, fullname
                 )
                 if not new_modname:
                     new_modname = _get_full_modname(modname, fullname)
@@ -146,11 +169,14 @@ def doctree_read(app: Sphinx, doctree: Node) -> None:
                 continue
             names.add(fullname)
             pagename = posixpath.join(OUTPUT_DIRNAME, modname.replace('.', '/'))
-            signode += viewcode_anchor(reftarget=pagename, refid=fullname, refdoc=env.docname)
+            signode += viewcode_anchor(
+                reftarget=pagename, refid=fullname, refdoc=env.docname
+            )
 
 
-def env_merge_info(app: Sphinx, env: BuildEnvironment, docnames: Iterable[str],
-                   other: BuildEnvironment) -> None:
+def env_merge_info(
+    app: Sphinx, env: BuildEnvironment, docnames: Set[str], other: BuildEnvironment
+) -> None:
     if not hasattr(other, '_viewcode_modules'):
         return
     # create a _viewcode_modules dict on the main environment
@@ -198,8 +224,13 @@ class ViewcodeAnchorTransform(SphinxPostTransform):
     def convert_viewcode_anchors(self) -> None:
         for node in self.document.findall(viewcode_anchor):
             anchor = nodes.inline('', _('[source]'), classes=['viewcode-link'])
-            refnode = make_refnode(self.app.builder, node['refdoc'], node['reftarget'],
-                                   node['refid'], anchor)
+            refnode = make_refnode(
+                self.app.builder,
+                node['refdoc'],
+                node['reftarget'],
+                node['refid'],
+                anchor,
+            )
             node.replace_self(refnode)
 
     def remove_viewcode_anchors(self) -> None:
@@ -207,9 +238,10 @@ class ViewcodeAnchorTransform(SphinxPostTransform):
             node.parent.remove(node)
 
 
-def get_module_filename(app: Sphinx, modname: str) -> str | None:
+def get_module_filename(app: Sphinx, modname: str) -> _StrPath | None:
     """Get module filename for *modname*."""
-    source_info = app.emit_firstresult('viewcode-find-source', modname)
+    events = app.events
+    source_info = events.emit_firstresult('viewcode-find-source', modname)
     if source_info:
         return None
     else:
@@ -227,9 +259,9 @@ def should_generate_module_page(app: Sphinx, modname: str) -> bool:
         # Always (re-)generate module page when module filename is not found.
         return True
 
-    builder = cast(StandaloneHTMLBuilder, app.builder)
+    builder = cast('StandaloneHTMLBuilder', app.builder)
     basename = modname.replace('.', '/') + builder.out_suffix
-    page_filename = path.join(app.outdir, '_modules/', basename)
+    page_filename = app.outdir / '_modules' / basename
 
     try:
         if _last_modified_time(module_filename) <= _last_modified_time(page_filename):
@@ -242,7 +274,7 @@ def should_generate_module_page(app: Sphinx, modname: str) -> bool:
 
 
 def collect_pages(app: Sphinx) -> Iterator[tuple[str, dict[str, Any], str]]:
-    env = app.builder.env
+    env = app.env
     if not hasattr(env, '_viewcode_modules'):
         return
     if not is_supported_builder(app.builder):
@@ -253,10 +285,13 @@ def collect_pages(app: Sphinx) -> Iterator[tuple[str, dict[str, Any], str]]:
     modnames = set(env._viewcode_modules)
 
     for modname, entry in status_iterator(
-            sorted(env._viewcode_modules.items()),
-            __('highlighting module code... '), "blue",
-            len(env._viewcode_modules),
-            app.verbosity, operator.itemgetter(0)):
+        sorted(env._viewcode_modules.items()),
+        __('highlighting module code... '),
+        'blue',
+        len(env._viewcode_modules),
+        app.verbosity,
+        operator.itemgetter(0),
+    ):
         if not entry:
             continue
         if not should_generate_module_page(app, modname):
@@ -286,9 +321,11 @@ def collect_pages(app: Sphinx) -> Iterator[tuple[str, dict[str, Any], str]]:
         for name, docname in used.items():
             type, start, end = tags[name]
             backlink = urito(pagename, docname) + '#' + refname + '.' + name
-            lines[start] = (f'<div class="viewcode-block" id="{name}">\n'
-                            f'<a class="viewcode-back" href="{backlink}">{link_text}</a>\n'
-                            + lines[start])
+            lines[start] = (
+                f'<div class="viewcode-block" id="{name}">\n'
+                f'<a class="viewcode-back" href="{backlink}">{link_text}</a>\n'
+                + lines[start]
+            )
             lines[min(end, max_index)] += '</div>\n'
 
         # try to find parents (for submodules)
@@ -298,20 +335,24 @@ def collect_pages(app: Sphinx) -> Iterator[tuple[str, dict[str, Any], str]]:
             parent = parent.rsplit('.', 1)[0]
             if parent in modnames:
                 parents.append({
-                    'link': urito(pagename,
-                                  posixpath.join(OUTPUT_DIRNAME, parent.replace('.', '/'))),
-                    'title': parent})
-        parents.append({'link': urito(pagename, posixpath.join(OUTPUT_DIRNAME, 'index')),
-                        'title': _('Module code')})
+                    'link': urito(
+                        pagename,
+                        posixpath.join(OUTPUT_DIRNAME, parent.replace('.', '/')),
+                    ),
+                    'title': parent,
+                })
+        parents.append({
+            'link': urito(pagename, posixpath.join(OUTPUT_DIRNAME, 'index')),
+            'title': _('Module code'),
+        })
         parents.reverse()
         # putting it all together
         context = {
             'parents': parents,
             'title': modname,
-            'body': (_('<h1>Source code for %s</h1>') % modname +
-                     '\n'.join(lines)),
+            'body': (_('<h1>Source code for %s</h1>') % modname + '\n'.join(lines)),
         }
-        yield (pagename, context, 'page.html')
+        yield pagename, context, 'page.html'
 
     if not modnames:
         return
@@ -329,30 +370,37 @@ def collect_pages(app: Sphinx) -> Iterator[tuple[str, dict[str, Any], str]]:
                 stack.pop()
                 html.append('</ul>')
             stack.append(modname + '.')
-        relative_uri = urito(posixpath.join(OUTPUT_DIRNAME, 'index'),
-                             posixpath.join(OUTPUT_DIRNAME, modname.replace('.', '/')))
+        relative_uri = urito(
+            posixpath.join(OUTPUT_DIRNAME, 'index'),
+            posixpath.join(OUTPUT_DIRNAME, modname.replace('.', '/')),
+        )
         html.append(f'<li><a href="{relative_uri}">{modname}</a></li>\n')
     html.append('</ul>' * (len(stack) - 1))
     context = {
         'title': _('Overview: module code'),
-        'body': (_('<h1>All modules for which code is available</h1>') +
-                 ''.join(html)),
+        'body': (_('<h1>All modules for which code is available</h1>') + ''.join(html)),
     }
 
-    yield (posixpath.join(OUTPUT_DIRNAME, 'index'), context, 'page.html')
+    yield posixpath.join(OUTPUT_DIRNAME, 'index'), context, 'page.html'
 
 
 def setup(app: Sphinx) -> ExtensionMetadata:
-    app.add_config_value('viewcode_import', None, '')
-    app.add_config_value('viewcode_enable_epub', False, '')
-    app.add_config_value('viewcode_follow_imported_members', True, '')
-    app.add_config_value('viewcode_line_numbers', False, 'env', bool)
+    app.add_config_value('viewcode_import', None, '', types=frozenset({NoneType}))
+    app.add_config_value('viewcode_enable_epub', False, '', types=frozenset({bool}))
+    app.add_config_value(
+        'viewcode_follow_imported_members', True, '', types=frozenset({bool})
+    )
+    app.add_config_value('viewcode_line_numbers', False, 'env', types=frozenset({bool}))
     app.connect('doctree-read', doctree_read)
     app.connect('env-merge-info', env_merge_info)
     app.connect('env-purge-doc', env_purge_doc)
     app.connect('html-collect-pages', collect_pages)
-    # app.add_config_value('viewcode_include_modules', [], 'env')
-    # app.add_config_value('viewcode_exclude_modules', [], 'env')
+    # app.add_config_value(
+    #     'viewcode_include_modules', [], 'env', types=frozenset({list, tuple})
+    # )
+    # app.add_config_value(
+    #     'viewcode_exclude_modules', [], 'env', types=frozenset({list, tuple})
+    # )
     app.add_event('viewcode-find-source')
     app.add_event('viewcode-follow-imported')
     app.add_post_transform(ViewcodeAnchorTransform)

sphinx/extension.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from packaging.version import InvalidVersion, Version
 
@@ -11,6 +11,8 @@ from sphinx.locale import __
 from sphinx.util import logging
 
 if TYPE_CHECKING:
+    from typing import Any
+
     from sphinx.application import Sphinx
     from sphinx.config import Config
     from sphinx.util.typing import ExtensionMetadata

sphinx/highlighting.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 from functools import partial
 from importlib import import_module
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 import pygments
 from pygments import highlight
@@ -27,12 +27,14 @@ from sphinx.pygments_styles import NoneStyle, SphinxStyle
 from sphinx.util import logging, texescape
 
 if TYPE_CHECKING:
+    from typing import Any
+
     from pygments.formatter import Formatter
     from pygments.lexer import Lexer
     from pygments.style import Style
 
-if tuple(map(int, pygments.__version__.split('.')))[:2] < (2, 18):
-    from pygments.formatter import Formatter  # NoQA: F811
+if tuple(map(int, pygments.__version__.split('.')[:2])) < (2, 18):
+    from pygments.formatter import Formatter
 
     Formatter.__class_getitem__ = classmethod(lambda cls, name: cls)  # type: ignore[attr-defined]
 
@@ -127,7 +129,7 @@ class PygmentsBridge:
         else:
             return get_style_by_name(stylename)
 
-    def get_formatter(self, **kwargs: Any) -> Formatter:
+    def get_formatter(self, **kwargs: Any) -> Formatter[str]:
         kwargs.update(self.formatter_args)
         return self.formatter(**kwargs)
 
@@ -135,7 +137,7 @@ class PygmentsBridge:
         self,
         source: str,
         lang: str,
-        opts: dict | None = None,
+        opts: dict[str, Any] | None = None,
         force: bool = False,
         location: Any = None,
     ) -> Lexer:
@@ -165,7 +167,11 @@ class PygmentsBridge:
                     lexer = get_lexer_by_name(lang, **opts)
             except ClassNotFound:
                 logger.warning(
-                    __('Pygments lexer name %r is not known'), lang, location=location
+                    __('Pygments lexer name %r is not known'),
+                    lang,
+                    location=location,
+                    type='misc',
+                    subtype='higlighting_failure',
                 )
                 lexer = lexer_classes['none'](**opts)
 
@@ -178,7 +184,7 @@ class PygmentsBridge:
         self,
         source: str,
         lang: str,
-        opts: dict | None = None,
+        opts: dict[str, Any] | None = None,
         force: bool = False,
         location: Any = None,
         **kwargs: Any,

sphinx/io.py

@@ -2,15 +2,14 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from docutils.core import Publisher
-from docutils.io import FileInput, Input, NullOutput
+from docutils.io import FileInput, NullOutput
 from docutils.readers import standalone
 from docutils.transforms.references import DanglingReferences
 from docutils.writers import UnfilteredWriter
 
-from sphinx import addnodes
 from sphinx.transforms import AutoIndexUpgrader, DoctreeReadEvent, SphinxTransformer
 from sphinx.transforms.i18n import (
     Locale,
@@ -23,8 +22,11 @@ from sphinx.util.docutils import LoggingReporter
 from sphinx.versioning import UIDTransform
 
 if TYPE_CHECKING:
+    from typing import Any
+
     from docutils import nodes
     from docutils.frontend import Values
+    from docutils.io import Input
     from docutils.parsers import Parser
     from docutils.transforms import Transform
 
@@ -36,8 +38,7 @@ logger = logging.getLogger(__name__)
 
 
 class SphinxBaseReader(standalone.Reader):  # type: ignore[misc]
-    """
-    A base class of readers for Sphinx.
+    """A base class of readers for Sphinx.
 
     This replaces reporter by Sphinx's on generating document.
     """
@@ -70,12 +71,10 @@ class SphinxBaseReader(standalone.Reader):  # type: ignore[misc]
         return transforms
 
     def new_document(self) -> nodes.document:
-        """
-        Creates a new document object which has a special reporter object good
+        """Creates a new document object which has a special reporter object good
         for logging.
         """
         document = super().new_document()
-        document.__class__ = addnodes.document  # replace the class with patched version
 
         # substitute transformer
         document.transformer = SphinxTransformer(document)
@@ -89,9 +88,7 @@ class SphinxBaseReader(standalone.Reader):  # type: ignore[misc]
 
 
 class SphinxStandaloneReader(SphinxBaseReader):
-    """
-    A basic document reader for Sphinx.
-    """
+    """A basic document reader for Sphinx."""
 
     def setup(self, app: Sphinx) -> None:
         self.transforms = self.transforms + app.registry.get_transforms()
@@ -117,8 +114,7 @@ class SphinxStandaloneReader(SphinxBaseReader):
 
 
 class SphinxI18nReader(SphinxBaseReader):
-    """
-    A document reader for i18n.
+    """A document reader for i18n.
 
     This returns the source line number of original text as current source line number
     to let users know where the error happened.