Sphinx 8.1.3__py3-none-any.whl → 8.2.0rc1__py3-none-any.whl

sphinx/writers/manpage.py

@@ -2,8 +2,7 @@
 
 from __future__ import annotations
 
-from collections.abc import Iterable
-from typing import TYPE_CHECKING, Any, cast
+from typing import TYPE_CHECKING, cast
 
 from docutils import nodes
 from docutils.writers.manpage import Translator as BaseTranslator
@@ -17,6 +16,9 @@ from sphinx.util.i18n import format_date
 from sphinx.util.nodes import NodeMatcher
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable
+    from typing import Any
+
     from docutils.nodes import Element
 
     from sphinx.builders import Builder
@@ -33,14 +35,13 @@ class ManualPageWriter(Writer):  # type: ignore[misc]
         transform = NestedInlineTransform(self.document)
         transform.apply()
         visitor = self.builder.create_translator(self.document, self.builder)
-        self.visitor = cast(ManualPageTranslator, visitor)
+        self.visitor = cast('ManualPageTranslator', visitor)
         self.document.walkabout(visitor)
         self.output = self.visitor.astext()
 
 
 class NestedInlineTransform:
-    """
-    Flatten nested inline nodes:
+    """Flatten nested inline nodes:
 
     Before:
         <strong>foo=<emphasis>1</emphasis>
@@ -71,17 +72,13 @@ class NestedInlineTransform:
 
 
 class ManualPageTranslator(SphinxTranslator, BaseTranslator):  # type: ignore[misc]
-    """
-    Custom man page translator.
-    """
+    """Custom man page translator."""
 
     _docinfo: dict[str, Any] = {}
 
     def __init__(self, document: nodes.document, builder: Builder) -> None:
         super().__init__(document, builder)
 
-        self.in_productionlist = 0
-
         # first title is the manpage title
         self.section_level = -1
 
@@ -117,7 +114,7 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):  # type: ignore[mi
             ' "%(date)s" "%(version)s" "%(manual_group)s"\n'
         )
         if self._docinfo['subtitle']:
-            tmpl += '.SH NAME\n' '%(title)s \\- %(subtitle)s\n'
+            tmpl += '.SH NAME\n%(title)s \\- %(subtitle)s\n'
         return tmpl % self._docinfo
 
     def visit_start_of_file(self, node: Element) -> None:
@@ -259,7 +256,7 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):  # type: ignore[mi
     # overwritten -- handle footnotes rubric
     def visit_rubric(self, node: Element) -> None:
         self.ensure_eol()
-        if len(node) == 1 and node.astext() in ('Footnotes', _('Footnotes')):
+        if len(node) == 1 and node.astext() in {'Footnotes', _('Footnotes')}:
             self.body.append('.SH ' + self.deunicode(node.astext()).upper() + '\n')
             raise nodes.SkipNode
         self.body.append('.sp\n')
@@ -275,26 +272,10 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):  # type: ignore[mi
 
     def visit_productionlist(self, node: Element) -> None:
         self.ensure_eol()
-        self.in_productionlist += 1
         self.body.append('.sp\n.nf\n')
-        productionlist = cast(Iterable[addnodes.production], node)
-        names = (production['tokenname'] for production in productionlist)
-        maxlen = max(len(name) for name in names)
-        lastname = None
-        for production in productionlist:
-            if production['tokenname']:
-                lastname = production['tokenname'].ljust(maxlen)
-                self.body.append(self.defs['strong'][0])
-                self.body.append(self.deunicode(lastname))
-                self.body.append(self.defs['strong'][1])
-                self.body.append(' ::= ')
-            elif lastname is not None:
-                self.body.append('%s     ' % (' ' * len(lastname)))
-            production.walkabout(self)
-            self.body.append('\n')
+
+    def depart_productionlist(self, node: Element) -> None:
         self.body.append('\n.fi\n')
-        self.in_productionlist -= 1
-        raise nodes.SkipNode
 
     def visit_production(self, node: Element) -> None:
         pass
@@ -379,11 +360,11 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):  # type: ignore[mi
         pass
 
     def visit_acks(self, node: Element) -> None:
-        bullet_list = cast(nodes.bullet_list, node[0])
-        list_items = cast(Iterable[nodes.list_item], bullet_list)
+        bullet_list = cast('nodes.bullet_list', node[0])
+        list_items = cast('Iterable[nodes.list_item]', bullet_list)
         self.ensure_eol()
-        bullet_list = cast(nodes.bullet_list, node[0])
-        list_items = cast(Iterable[nodes.list_item], bullet_list)
+        bullet_list = cast('nodes.bullet_list', node[0])
+        list_items = cast('Iterable[nodes.list_item]', bullet_list)
         self.body.append(', '.join(n.astext() for n in list_items) + '.')
         self.body.append('\n')
         raise nodes.SkipNode
@@ -477,14 +458,14 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):  # type: ignore[mi
     def depart_inline(self, node: Element) -> None:
         pass
 
-    def visit_math(self, node: Element) -> None:
+    def visit_math(self, node: nodes.math) -> None:
         pass
 
-    def depart_math(self, node: Element) -> None:
+    def depart_math(self, node: nodes.math) -> None:
         pass
 
-    def visit_math_block(self, node: Element) -> None:
+    def visit_math_block(self, node: nodes.math_block) -> None:
         self.visit_centered(node)
 
-    def depart_math_block(self, node: Element) -> None:
+    def depart_math_block(self, node: nodes.math_block) -> None:
         self.depart_centered(node)

sphinx/writers/texinfo.py

@@ -2,16 +2,14 @@
 
 from __future__ import annotations
 
+import os.path
 import re
 import textwrap
-from collections.abc import Iterable, Iterator
-from os import path
-from typing import TYPE_CHECKING, Any, ClassVar, cast
+from typing import TYPE_CHECKING, cast
 
 from docutils import nodes, writers
 
 from sphinx import __display_version__, addnodes
-from sphinx.errors import ExtensionError
 from sphinx.locale import _, __, admonitionlabels
 from sphinx.util import logging
 from sphinx.util.docutils import SphinxTranslator
@@ -19,6 +17,9 @@ from sphinx.util.i18n import format_date
 from sphinx.writers.latex import collected_footnote
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable, Iterator
+    from typing import Any, ClassVar
+
     from docutils.nodes import Element, Node, Text
 
     from sphinx.builders.texinfo import TexinfoBuilder
@@ -133,7 +134,7 @@ class TexinfoWriter(writers.Writer):  # type: ignore[type-arg]
     def translate(self) -> None:
         assert isinstance(self.document, nodes.document)
         visitor = self.builder.create_translator(self.document, self.builder)
-        self.visitor = cast(TexinfoTranslator, visitor)
+        self.visitor = cast('TexinfoTranslator', visitor)
         self.document.walkabout(visitor)
         self.visitor.finish()
         for attr in self.visitor_attributes:
@@ -188,6 +189,7 @@ class TexinfoTranslator(SphinxTranslator):
         self.escape_hyphens = 0
         self.curfilestack: list[str] = []
         self.footnotestack: list[dict[str, list[collected_footnote | bool]]] = []
+        self.in_production_list = False
         self.in_footnote = 0
         self.in_samp = 0
         self.handled_abbrs: set[str] = set()
@@ -240,7 +242,7 @@ class TexinfoTranslator(SphinxTranslator):
         # filename
         if not elements['filename']:
             elements['filename'] = self.document.get('source') or 'untitled'
-            if elements['filename'][-4:] in ('.txt', '.rst'):  # type: ignore[index]
+            if elements['filename'][-4:] in {'.txt', '.rst'}:  # type: ignore[index]
                 elements['filename'] = elements['filename'][:-4]  # type: ignore[index]
             elements['filename'] += '.info'  # type: ignore[operator]
         # direntry
@@ -250,9 +252,10 @@ class TexinfoTranslator(SphinxTranslator):
                 '(%s)' % elements['filename'],
                 self.escape_arg(self.settings.texinfo_dir_description),
             )
-            elements['direntry'] = (
-                '@dircategory %s\n' '@direntry\n' '%s' '@end direntry\n'
-            ) % (self.escape_id(self.settings.texinfo_dir_category), entry)
+            elements['direntry'] = '@dircategory %s\n@direntry\n%s@end direntry\n' % (
+                self.escape_id(self.settings.texinfo_dir_category),
+                entry,
+            )
         elements['copying'] = COPYING % elements
         # allow the user to override them all
         elements.update(self.settings.texinfo_elements)
@@ -287,7 +290,7 @@ class TexinfoTranslator(SphinxTranslator):
         ]
         # each section is also a node
         for section in self.document.findall(nodes.section):
-            title = cast(nodes.TextElement, section.next_node(nodes.Titular))  # type: ignore[type-var]
+            title = cast('nodes.TextElement', section.next_node(nodes.Titular))  # type: ignore[type-var]
             name = title.astext() if title else '<untitled>'
             section['node_name'] = add_node_name(name)
 
@@ -448,10 +451,10 @@ class TexinfoTranslator(SphinxTranslator):
             for subentry in entries:
                 _add_detailed_menu(subentry)
 
-        self.body.append('\n@detailmenu\n' ' --- The Detailed Node Listing ---\n')
+        self.body.append('\n@detailmenu\n --- The Detailed Node Listing ---\n')
         for entry in entries:
             _add_detailed_menu(entry)
-        self.body.append('\n@end detailmenu\n' '@end menu\n')
+        self.body.append('\n@end detailmenu\n@end menu\n')
 
     def tex_image_length(self, width_str: str) -> str:
         match = re.match(r'(\d*\.?\d*)\s*(\S*)', width_str)
@@ -491,7 +494,7 @@ class TexinfoTranslator(SphinxTranslator):
                 indices_config = frozenset(indices_config)
             else:
                 check_names = False
-            for domain in self.builder.env.domains.sorted():
+            for domain in self._domains.sorted():
                 for index_cls in domain.indices:
                     index_name = f'{domain.name}-{index_cls.name}'
                     if check_names and index_name not in indices_config:
@@ -505,7 +508,7 @@ class TexinfoTranslator(SphinxTranslator):
                             generate(content, collapsed),
                         ))
         # only add the main Index if it's not empty
-        domain = self.builder.env.domains.index_domain
+        domain = self._domains.index_domain
         for docname in self.builder.docnames:
             if domain.entries[docname]:
                 self.indices.append((_('Index'), '\n@printindex ge\n'))
@@ -529,7 +532,7 @@ class TexinfoTranslator(SphinxTranslator):
 
         fnotes: dict[str, list[collected_footnote | bool]] = {}
         for fn in footnotes_under(node):
-            label = cast(nodes.label, fn[0])
+            label = cast('nodes.label', fn[0])
             num = label.astext().strip()
             fnotes[num] = [collected_footnote('', *fn.children), False]
         return fnotes
@@ -608,7 +611,7 @@ class TexinfoTranslator(SphinxTranslator):
             self.add_anchor(id, node)
 
         self.next_section_ids.clear()
-        self.previous_section = cast(nodes.section, node)
+        self.previous_section = cast('nodes.section', node)
         self.section_level += 1
 
     def depart_section(self, node: Element) -> None:
@@ -657,7 +660,7 @@ class TexinfoTranslator(SphinxTranslator):
         self.body.append('\n\n')
 
     def visit_rubric(self, node: Element) -> None:
-        if len(node) == 1 and node.astext() in ('Footnotes', _('Footnotes')):
+        if len(node) == 1 and node.astext() in {'Footnotes', _('Footnotes')}:
             raise nodes.SkipNode
         try:
             rubric = self.rubrics[self.section_level]
@@ -1109,7 +1112,7 @@ class TexinfoTranslator(SphinxTranslator):
 
     def visit_admonition(self, node: Element, name: str = '') -> None:
         if not name:
-            title = cast(nodes.title, node[0])
+            title = cast('nodes.title', node[0])
             name = self.escape(title.astext())
         self.body.append('\n@cartouche\n@quotation %s ' % name)
 
@@ -1119,7 +1122,7 @@ class TexinfoTranslator(SphinxTranslator):
 
     def depart_admonition(self, node: Element) -> None:
         self.ensure_eol()
-        self.body.append('@end quotation\n' '@end cartouche\n')
+        self.body.append('@end quotation\n@end cartouche\n')
 
     visit_attention = _visit_named_admonition
     depart_attention = depart_admonition
@@ -1170,9 +1173,9 @@ class TexinfoTranslator(SphinxTranslator):
 
     def visit_topic(self, node: Element) -> None:
         # ignore TOC's since we have to have a "menu" anyway
-        if 'contents' in node.get('classes', []):
+        if 'contents' in node.get('classes', ()):
             raise nodes.SkipNode
-        title = cast(nodes.title, node[0])
+        title = cast('nodes.title', node[0])
         self.visit_rubric(title)
         self.body.append('%s\n' % self.escape(title.astext()))
         self.depart_rubric(title)
@@ -1231,12 +1234,12 @@ class TexinfoTranslator(SphinxTranslator):
         if uri.find('://') != -1:
             # ignore remote images
             return
-        name, ext = path.splitext(uri)
+        name, ext = os.path.splitext(uri)
         # width and height ignored in non-tex output
         width = self.tex_image_length(node.get('width', ''))
         height = self.tex_image_length(node.get('height', ''))
         alt = self.escape_arg(node.get('alt', ''))
-        filename = f"{self.elements['filename'][:-5]}-figures/{name}"  # type: ignore[index]
+        filename = f'{self.elements["filename"][:-5]}-figures/{name}'  # type: ignore[index]
         self.body.append(f'\n@image{{{filename},{width},{height},{alt},{ext[1:]}}}\n')
 
     def depart_image(self, node: Element) -> None:
@@ -1280,7 +1283,7 @@ class TexinfoTranslator(SphinxTranslator):
 
     def visit_system_message(self, node: Element) -> None:
         self.body.append(
-            '\n@verbatim\n' '<SYSTEM MESSAGE: %s>\n' '@end verbatim\n' % node.astext()
+            '\n@verbatim\n<SYSTEM MESSAGE: %s>\n@end verbatim\n' % node.astext()
         )
         raise nodes.SkipNode
 
@@ -1306,21 +1309,11 @@ class TexinfoTranslator(SphinxTranslator):
 
     def visit_productionlist(self, node: Element) -> None:
         self.visit_literal_block(None)
-        productionlist = cast(Iterable[addnodes.production], node)
-        names = (production['tokenname'] for production in productionlist)
-        maxlen = max(len(name) for name in names)
-
-        for production in productionlist:
-            if production['tokenname']:
-                for id in production.get('ids'):
-                    self.add_anchor(id, production)
-                s = production['tokenname'].ljust(maxlen) + ' ::='
-            else:
-                s = '%s    ' % (' ' * maxlen)
-            self.body.append(self.escape(s))
-            self.body.append(self.escape(production.astext() + '\n'))
+        self.in_production_list = True
+
+    def depart_productionlist(self, node: Element) -> None:
+        self.in_production_list = False
         self.depart_literal_block(None)
-        raise nodes.SkipNode
 
     def visit_production(self, node: Element) -> None:
         pass
@@ -1335,9 +1328,15 @@ class TexinfoTranslator(SphinxTranslator):
         self.body.append('}')
 
     def visit_literal_strong(self, node: Element) -> None:
+        if self.in_production_list:
+            for id_ in node['ids']:
+                self.add_anchor(id_, node)
+            return
         self.body.append('@code{')
 
     def depart_literal_strong(self, node: Element) -> None:
+        if self.in_production_list:
+            return
         self.body.append('}')
 
     def visit_index(self, node: Element) -> None:
@@ -1387,8 +1386,8 @@ class TexinfoTranslator(SphinxTranslator):
         pass
 
     def visit_acks(self, node: Element) -> None:
-        bullet_list = cast(nodes.bullet_list, node[0])
-        list_items = cast(Iterable[nodes.list_item], bullet_list)
+        bullet_list = cast('nodes.bullet_list', node[0])
+        list_items = cast('Iterable[nodes.list_item]', bullet_list)
         self.body.append('\n\n')
         self.body.append(', '.join(n.astext() for n in list_items) + '.')
         self.body.append('\n\n')
@@ -1418,11 +1417,11 @@ class TexinfoTranslator(SphinxTranslator):
                 self.add_anchor(id, node)
         # use the full name of the objtype for the category
         try:
-            domain = self.builder.env.get_domain(node.parent['domain'])
+            domain = self._domains[node.parent['domain']]
             name = domain.get_type_name(
                 domain.object_types[objtype], self.config.primary_domain == domain.name
             )
-        except (KeyError, ExtensionError):
+        except KeyError:
             name = objtype
         # by convention, the deffn category should be capitalized like a title
         category = self.escape_arg(smart_capwords(name))
@@ -1501,7 +1500,7 @@ class TexinfoTranslator(SphinxTranslator):
             self.first_param = 0
         text = self.escape(node.astext())
         # replace no-break spaces with normal ones
-        text = text.replace(' ', '@w{ }')
+        text = text.replace('\N{NO-BREAK SPACE}', '@w{ }')
         self.body.append(text)
         raise nodes.SkipNode
 
@@ -1579,11 +1578,11 @@ class TexinfoTranslator(SphinxTranslator):
     def depart_pending_xref(self, node: Element) -> None:
         pass
 
-    def visit_math(self, node: Element) -> None:
+    def visit_math(self, node: nodes.math) -> None:
         self.body.append('@math{' + self.escape_arg(node.astext()) + '}')
         raise nodes.SkipNode
 
-    def visit_math_block(self, node: Element) -> None:
+    def visit_math_block(self, node: nodes.math_block) -> None:
         if node.get('label'):
             self.add_anchor(node['label'], node)
         self.body.append(

sphinx/writers/text.py

@@ -6,9 +6,8 @@ import math
 import os
 import re
 import textwrap
-from collections.abc import Iterable, Iterator, Sequence
 from itertools import chain, groupby, pairwise
-from typing import TYPE_CHECKING, Any, ClassVar, cast
+from typing import TYPE_CHECKING, cast
 
 from docutils import nodes, writers
 from docutils.utils import column_width
@@ -18,6 +17,9 @@ from sphinx.locale import _, admonitionlabels
 from sphinx.util.docutils import SphinxTranslator
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable, Iterator, Sequence
+    from typing import Any, ClassVar
+
     from docutils.nodes import Element, Text
 
     from sphinx.builders.text import TextBuilder
@@ -45,7 +47,7 @@ class Cell:
         return hash((self.col, self.row))
 
     def __bool__(self) -> bool:
-        return self.text != '' and self.col is not None and self.row is not None
+        return bool(self.text) and self.col is not None and self.row is not None
 
     def wrap(self, width: int) -> None:
         self.wrapped = my_wrap(self.text, width)
@@ -292,7 +294,7 @@ class TextWrapper(textwrap.TextWrapper):
 
             width = self.width - column_width(indent)
 
-            if self.drop_whitespace and chunks[-1].strip() == '' and lines:
+            if self.drop_whitespace and not chunks[-1].strip() and lines:
                 del chunks[-1]
 
             while chunks:
@@ -308,7 +310,7 @@ class TextWrapper(textwrap.TextWrapper):
             if chunks and column_width(chunks[-1]) > width:
                 self._handle_long_word(chunks, cur_line, cur_len, width)
 
-            if self.drop_whitespace and cur_line and cur_line[-1].strip() == '':
+            if self.drop_whitespace and cur_line and not cur_line[-1].strip():
                 del cur_line[-1]
 
             if cur_line:
@@ -381,7 +383,7 @@ class TextWriter(writers.Writer):  # type: ignore[type-arg]
         assert isinstance(self.document, nodes.document)
         visitor = self.builder.create_translator(self.document, self.builder)
         self.document.walkabout(visitor)
-        self.output = cast(TextTranslator, visitor).body
+        self.output = cast('TextTranslator', visitor).body
 
 
 class TextTranslator(SphinxTranslator):
@@ -406,6 +408,7 @@ class TextTranslator(SphinxTranslator):
         self.sectionlevel = 0
         self.lineblocklevel = 0
         self.table: Table
+        self.in_production_list = False
 
         self.context: list[str] = []
         """Heterogeneous stack.
@@ -646,6 +649,7 @@ class TextTranslator(SphinxTranslator):
         self.required_params_left = sum(self.list_is_required_param)
         self.param_separator = ', '
         self.multi_line_parameter_list = node.get('multi_line_parameter_list', False)
+        self.trailing_comma = node.get('multi_line_trailing_comma', False)
         if self.multi_line_parameter_list:
             self.param_separator = self.param_separator.rstrip()
         self.context.append(sig_close_paren)
@@ -697,7 +701,8 @@ class TextTranslator(SphinxTranslator):
                 or is_required
                 and (is_last_group or next_is_required)
             ):
-                self.add_text(self.param_separator)
+                if not is_last_group or opt_param_left_at_level or self.trailing_comma:
+                    self.add_text(self.param_separator)
                 self.end_state(wrap=False, end=None)
 
         elif self.required_params_left:
@@ -738,20 +743,27 @@ class TextTranslator(SphinxTranslator):
 
     def depart_desc_optional(self, node: Element) -> None:
         self.optional_param_level -= 1
+        level = self.optional_param_level
         if self.multi_line_parameter_list:
+            max_level = self.max_optional_param_level
+            len_lirp = len(self.list_is_required_param)
+            is_last_group = self.param_group_index + 1 == len_lirp
             # If it's the first time we go down one level, add the separator before the
-            # bracket.
-            if self.optional_param_level == self.max_optional_param_level - 1:
+            # bracket, except if this is the last parameter and the parameter list
+            # should not feature a trailing comma.
+            if level == max_level - 1 and (
+                not is_last_group or level > 0 or self.trailing_comma
+            ):
                 self.add_text(self.param_separator)
             self.add_text(']')
             # End the line if we have just closed the last bracket of this group of
             # optional parameters.
-            if self.optional_param_level == 0:
+            if level == 0:
                 self.end_state(wrap=False, end=None)
 
         else:
             self.add_text(']')
-        if self.optional_param_level == 0:
+        if level == 0:
             self.param_group_index += 1
 
     def visit_desc_annotation(self, node: Element) -> None:
@@ -776,22 +788,20 @@ class TextTranslator(SphinxTranslator):
 
     def visit_productionlist(self, node: Element) -> None:
         self.new_state()
-        productionlist = cast(Iterable[addnodes.production], node)
-        names = (production['tokenname'] for production in productionlist)
-        maxlen = max(len(name) for name in names)
-        lastname = None
-        for production in productionlist:
-            if production['tokenname']:
-                self.add_text(production['tokenname'].ljust(maxlen) + ' ::=')
-                lastname = production['tokenname']
-            elif lastname is not None:
-                self.add_text('%s    ' % (' ' * len(lastname)))
-            self.add_text(production.astext() + self.nl)
+        self.in_production_list = True
+
+    def depart_productionlist(self, node: Element) -> None:
+        self.in_production_list = False
         self.end_state(wrap=False)
-        raise nodes.SkipNode
+
+    def visit_production(self, node: Element) -> None:
+        pass
+
+    def depart_production(self, node: Element) -> None:
+        pass
 
     def visit_footnote(self, node: Element) -> None:
-        label = cast(nodes.label, node[0])
+        label = cast('nodes.label', node[0])
         self._footnote = label.astext().strip()
         self.new_state(len(self._footnote) + 3)
 
@@ -923,8 +933,8 @@ class TextTranslator(SphinxTranslator):
         self.end_state(wrap=False)
 
     def visit_acks(self, node: Element) -> None:
-        bullet_list = cast(nodes.bullet_list, node[0])
-        list_items = cast(Iterable[nodes.list_item], bullet_list)
+        bullet_list = cast('nodes.bullet_list', node[0])
+        list_items = cast('Iterable[nodes.list_item]', bullet_list)
         self.new_state(0)
         self.add_text(', '.join(n.astext() for n in list_items) + '.')
         self.end_state()
@@ -1214,9 +1224,13 @@ class TextTranslator(SphinxTranslator):
         self.add_text('**')
 
     def visit_literal_strong(self, node: Element) -> None:
+        if self.in_production_list:
+            return
         self.add_text('**')
 
     def depart_literal_strong(self, node: Element) -> None:
+        if self.in_production_list:
+            return
         self.add_text('**')
 
     def visit_abbreviation(self, node: Element) -> None:
@@ -1239,9 +1253,13 @@ class TextTranslator(SphinxTranslator):
         self.add_text('*')
 
     def visit_literal(self, node: Element) -> None:
+        if self.in_production_list:
+            return
         self.add_text('"')
 
     def depart_literal(self, node: Element) -> None:
+        if self.in_production_list:
+            return
         self.add_text('"')
 
     def visit_subscript(self, node: Element) -> None:
@@ -1316,14 +1334,14 @@ class TextTranslator(SphinxTranslator):
             self.end_state(wrap=False)
         raise nodes.SkipNode
 
-    def visit_math(self, node: Element) -> None:
+    def visit_math(self, node: nodes.math) -> None:
         pass
 
-    def depart_math(self, node: Element) -> None:
+    def depart_math(self, node: nodes.math) -> None:
         pass
 
-    def visit_math_block(self, node: Element) -> None:
+    def visit_math_block(self, node: nodes.math_block) -> None:
         self.new_state()
 
-    def depart_math_block(self, node: Element) -> None:
+    def depart_math_block(self, node: nodes.math_block) -> None:
         self.end_state()

sphinx/writers/xml.py

@@ -2,11 +2,13 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from docutils.writers.docutils_xml import Writer as BaseXMLWriter
 
 if TYPE_CHECKING:
+    from typing import Any
+
     from sphinx.builders import Builder
 
 
@@ -16,19 +18,20 @@ class XMLWriter(BaseXMLWriter):  # type: ignore[misc]
     def __init__(self, builder: Builder) -> None:
         super().__init__()
         self.builder = builder
-
-        # A lambda function to generate translator lazily
-        self.translator_class = lambda document: self.builder.create_translator(
-            document
-        )
+        self._config = builder.config
 
     def translate(self, *args: Any, **kwargs: Any) -> None:
         self.document.settings.newlines = self.document.settings.indents = (
-            self.builder.env.config.xml_pretty
+            self._config.xml_pretty
         )
         self.document.settings.xml_declaration = True
         self.document.settings.doctype_declaration = True
-        return super().translate()
+
+        # copied from docutils.writers.docutils_xml.Writer.translate()
+        # so that we can override the translator class
+        self.visitor = visitor = self.builder.create_translator(self.document)
+        self.document.walkabout(visitor)
+        self.output = ''.join(visitor.output)  # type: ignore[attr-defined]
 
 
 class PseudoXMLWriter(BaseXMLWriter):  # type: ignore[misc]

{sphinx-8.1.3.dist-info → sphinx-8.2.0rc1.dist-info}/LICENSE.rst

@@ -4,7 +4,7 @@ License for Sphinx
 Unless otherwise indicated, all code in the Sphinx project is licenced under the
 two clause BSD licence below.
 
-Copyright (c) 2007-2024 by the Sphinx team (see AUTHORS file).
+Copyright (c) 2007-2025 by the Sphinx team (see AUTHORS file).
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without