Sphinx 7.3.7__py3-none-any.whl → 7.4.0__py3-none-any.whl

sphinx/writers/html5.py

@@ -59,7 +59,6 @@ class HTML5Translator(SphinxTranslator, BaseTranslator):
 
         self.highlighter = self.builder.highlighter
         self.docnames = [self.builder.current_docname]  # for singlehtml builder
-        self.manpages_url = self.config.manpages_url
         self.protect_literal_text = 0
         self.secnumber_suffix = self.config.html_secnumber_suffix
         self.param_separator = ''
@@ -325,6 +324,8 @@ class HTML5Translator(SphinxTranslator, BaseTranslator):
             atts['title'] = node['reftitle']
         if 'target' in node:
             atts['target'] = node['target']
+        if 'rel' in node:
+            atts['rel'] = node['rel']
         self.body.append(self.starttag(node, 'a', '', **atts))
 
         if node.get('secnumber'):
@@ -508,6 +509,30 @@ class HTML5Translator(SphinxTranslator, BaseTranslator):
 
         super().depart_title(node)
 
+    # overwritten
+    def visit_rubric(self, node: Element) -> None:
+        if "level" in node:
+            level = node["level"]
+            if level in (1, 2, 3, 4, 5, 6):
+                self.body.append(self.starttag(node, f'h{level}', '', CLASS='rubric'))
+            else:
+                logger.warning(
+                    __('unsupported rubric heading level: %s'),
+                    level,
+                    type='html',
+                    location=node
+                )
+                super().visit_rubric(node)
+        else:
+            super().visit_rubric(node)
+
+    # overwritten
+    def depart_rubric(self, node: Element) -> None:
+        if level := node.get("level"):
+            self.body.append(f'</h{level}>\n')
+        else:
+            super().depart_rubric(node)
+
     # overwritten
     def visit_literal_block(self, node: Element) -> None:
         if node.rawsource != node.astext():
@@ -694,24 +719,6 @@ class HTML5Translator(SphinxTranslator, BaseTranslator):
                     if 'height' not in node:
                         node['height'] = str(size[1])
 
-        uri = node['uri']
-        if uri.lower().endswith(('svg', 'svgz')):
-            atts = {'src': uri}
-            if 'width' in node:
-                atts['width'] = node['width']
-            if 'height' in node:
-                atts['height'] = node['height']
-            if 'scale' in node:
-                if 'width' in atts:
-                    atts['width'] = multiply_length(atts['width'], node['scale'])
-                if 'height' in atts:
-                    atts['height'] = multiply_length(atts['height'], node['scale'])
-            atts['alt'] = node.get('alt', uri)
-            if 'align' in node:
-                atts['class'] = 'align-%s' % node['align']
-            self.body.append(self.emptytag(node, 'img', '', **atts))
-            return
-
         super().visit_image(node)
 
     # overwritten

sphinx/writers/latex.py

@@ -332,8 +332,8 @@ class LaTeXTranslator(SphinxTranslator):
                 self.top_sectionlevel = \
                     self.sectionnames.index(self.config.latex_toplevel_sectioning)
             except ValueError:
-                logger.warning(__('unknown %r toplevel_sectioning for class %r') %
-                               (self.config.latex_toplevel_sectioning, self.theme.docclass))
+                logger.warning(__('unknown %r toplevel_sectioning for class %r'),
+                               self.config.latex_toplevel_sectioning, self.theme.docclass)
 
         if self.config.numfig:
             self.numfig_secnum_depth = self.config.numfig_secnum_depth
@@ -437,7 +437,7 @@ class LaTeXTranslator(SphinxTranslator):
             'body': ''.join(self.body),
             'indices': self.generate_indices(),
         })
-        return self.render('latex.tex_t', self.elements)
+        return self.render('latex.tex.jinja', self.elements)
 
     def hypertarget(self, id: str, withdoc: bool = True, anchor: bool = True) -> str:
         if withdoc:
@@ -497,20 +497,23 @@ class LaTeXTranslator(SphinxTranslator):
 
         ret = []
         # latex_domain_indices can be False/True or a list of index names
-        indices_config = self.config.latex_domain_indices
-        if indices_config:
-            for domain in self.builder.env.domains.values():
-                for indexcls in domain.indices:
-                    indexname = f'{domain.name}-{indexcls.name}'
-                    if isinstance(indices_config, list):
-                        if indexname not in indices_config:
-                            continue
-                    content, collapsed = indexcls(domain).generate(
-                        self.builder.docnames)
-                    if not content:
+        if indices_config := self.config.latex_domain_indices:
+            if not isinstance(indices_config, bool):
+                check_names = True
+                indices_config = frozenset(indices_config)
+            else:
+                check_names = False
+            for domain_name in sorted(self.builder.env.domains):
+                domain = self.builder.env.domains[domain_name]
+                for index_cls in domain.indices:
+                    index_name = f'{domain.name}-{index_cls.name}'
+                    if check_names and index_name not in indices_config:
                         continue
-                    ret.append(r'\renewcommand{\indexname}{%s}' % indexcls.localname + CR)
-                    generate(content, collapsed)
+                    content, collapsed = index_cls(domain).generate(
+                        self.builder.docnames)
+                    if content:
+                        ret.append(r'\renewcommand{\indexname}{%s}' % index_cls.localname + CR)
+                        generate(content, collapsed)
 
         return ''.join(ret)
 
@@ -521,6 +524,12 @@ class LaTeXTranslator(SphinxTranslator):
                                  template_name)
             if path.exists(template):
                 return renderer.render(template, variables)
+            elif template.endswith('.jinja'):
+                legacy_template = template.removesuffix('.jinja') + '_t'
+                if path.exists(legacy_template):
+                    logger.warning(__('template %s not found; loading from legacy %s instead'),
+                                   template_name, legacy_template)
+                    return renderer.render(legacy_template, variables)
 
         return renderer.render(template_name, variables)
 
@@ -715,19 +724,21 @@ class LaTeXTranslator(SphinxTranslator):
             return e.get('multi_line_parameter_list')
 
         self.has_tp_list = False
+        self.orphan_tp_list = False
 
         for child in node:
             if isinstance(child, addnodes.desc_type_parameter_list):
                 self.has_tp_list = True
-                # recall that return annotations must follow an argument list,
-                # so signatures of the form "foo[tp_list] -> retann" will not
-                # be encountered (if they should, the `domains.python.py_sig_re`
-                # pattern must be modified accordingly)
-                arglist = next_sibling(child)
-                assert isinstance(arglist, addnodes.desc_parameterlist)
-                # tp_list + arglist: \macro{name}{tp_list}{arglist}{return}
                 multi_tp_list = has_multi_line(child)
-                multi_arglist = has_multi_line(arglist)
+                arglist = next_sibling(child)
+                if isinstance(arglist, addnodes.desc_parameterlist):
+                    # tp_list + arglist: \macro{name}{tp_list}{arglist}{retann}
+                    multi_arglist = has_multi_line(arglist)
+                else:
+                    # orphan tp_list:    \macro{name}{tp_list}{}{retann}
+                    # see: https://github.com/sphinx-doc/sphinx/issues/12543
+                    self.orphan_tp_list = True
+                    multi_arglist = False
 
                 if multi_tp_list:
                     if multi_arglist:
@@ -742,7 +753,7 @@ class LaTeXTranslator(SphinxTranslator):
                 break
 
             if isinstance(child, addnodes.desc_parameterlist):
-                # arglist only: \macro{name}{arglist}{return}
+                # arglist only: \macro{name}{arglist}{retann}
                 if has_multi_line(child):
                     self.body.append(CR + r'\pysigwithonelineperarg{')
                 else:
@@ -848,7 +859,13 @@ class LaTeXTranslator(SphinxTranslator):
         self.multi_line_parameter_list = node.get('multi_line_parameter_list', False)
 
     def visit_desc_parameterlist(self, node: Element) -> None:
-        if not self.has_tp_list:
+        if self.has_tp_list:
+            if self.orphan_tp_list:
+                # close type parameters list (#2)
+                self.body.append('}{')
+                # empty parameters list argument (#3)
+                return
+        else:
             # close name argument (#1), open parameters list argument (#2)
             self.body.append('}{')
         self._visit_sig_parameter_list(node, addnodes.desc_parameter)
@@ -958,7 +975,20 @@ class LaTeXTranslator(SphinxTranslator):
     def visit_rubric(self, node: Element) -> None:
         if len(node) == 1 and node.astext() in ('Footnotes', _('Footnotes')):
             raise nodes.SkipNode
-        self.body.append(r'\subsubsection*{')
+        tag = 'subsubsection'
+        if "level" in node:
+            level = node["level"]
+            try:
+                tag = self.sectionnames[self.top_sectionlevel - 1 + level]
+            except Exception:
+                logger.warning(
+                    __('unsupported rubric heading level: %s'),
+                    level,
+                    type='latex',
+                    location=node
+                )
+
+        self.body.append(rf'\{tag}*{{')
         self.context.append('}' + CR)
         self.in_title = 1
 
@@ -1033,7 +1063,7 @@ class LaTeXTranslator(SphinxTranslator):
         assert self.table is not None
         labels = self.hypertarget_to(node)
         table_type = self.table.get_table_type()
-        table = self.render(table_type + '.tex_t',
+        table = self.render(table_type + '.tex.jinja',
                             {'table': self.table, 'labels': labels})
         self.body.append(BLANKLINE)
         self.body.append(table)

sphinx/writers/manpage.py

@@ -309,7 +309,8 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):
     # overwritten -- don't visit inner marked up nodes
     def visit_reference(self, node: Element) -> None:
         uri = node.get('refuri', '')
-        if uri:
+        is_safe_to_click = uri.startswith(('mailto:', 'http:', 'https:', 'ftp:'))
+        if is_safe_to_click:
             # OSC 8 link start (using groff's device control directive).
             self.body.append(fr"\X'tty: link {uri}'")
 
@@ -319,7 +320,7 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):
         self.visit_Text(node)
         self.body.append(self.defs['reference'][1])
 
-        if uri.startswith(('mailto:', 'http:', 'https:', 'ftp:')):
+        if uri and not uri.startswith('#'):
             # if configured, put the URL after the link
             if self.config.man_show_urls and node.astext() != uri:
                 if uri.startswith('mailto:'):
@@ -328,7 +329,7 @@ class ManualPageTranslator(SphinxTranslator, BaseTranslator):
                     ' <',
                     self.defs['strong'][0], uri, self.defs['strong'][1],
                     '>'])
-        if uri:
+        if is_safe_to_click:
             # OSC 8 link end.
             self.body.append(r"\X'tty: link'")
         raise nodes.SkipNode

sphinx/writers/texinfo.py

@@ -476,20 +476,25 @@ class TexinfoTranslator(SphinxTranslator):
             ret.append('@end menu\n')
             return ''.join(ret)
 
-        indices_config = self.config.texinfo_domain_indices
-        if indices_config:
-            for domain in self.builder.env.domains.values():
-                for indexcls in domain.indices:
-                    indexname = f'{domain.name}-{indexcls.name}'
-                    if isinstance(indices_config, list):
-                        if indexname not in indices_config:
-                            continue
-                    content, collapsed = indexcls(domain).generate(
-                        self.builder.docnames)
-                    if not content:
+        if indices_config := self.config.texinfo_domain_indices:
+            if not isinstance(indices_config, bool):
+                check_names = True
+                indices_config = frozenset(indices_config)
+            else:
+                check_names = False
+            for domain_name in sorted(self.builder.env.domains):
+                domain = self.builder.env.domains[domain_name]
+                for index_cls in domain.indices:
+                    index_name = f'{domain.name}-{index_cls.name}'
+                    if check_names and index_name not in indices_config:
                         continue
-                    self.indices.append((indexcls.localname,
-                                         generate(content, collapsed)))
+                    content, collapsed = index_cls(domain).generate(
+                        self.builder.docnames)
+                    if content:
+                        self.indices.append((
+                            index_cls.localname,
+                            generate(content, collapsed),
+                        ))
         # only add the main Index if it's not empty
         domain = cast(IndexDomain, self.builder.env.get_domain('index'))
         for docname in self.builder.docnames:
@@ -691,7 +696,7 @@ class TexinfoTranslator(SphinxTranslator):
         # cases for the sake of appearance
         if isinstance(node.parent, (nodes.title, addnodes.desc_type)):
             return
-        if isinstance(node[0], nodes.image):
+        if len(node) != 0 and isinstance(node[0], nodes.image):
             return
         name = node.get('name', node.astext()).strip()
         uri = node.get('refuri', '')

{sphinx-7.3.7.dist-info → sphinx-7.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Sphinx
-Version: 7.3.7
+Version: 7.4.0
 Summary: Python documentation generator
 Author-email: Georg Brandl <georg@python.org>
 Requires-Python: >=3.9
@@ -48,32 +48,33 @@ Requires-Dist: sphinxcontrib-jsmath
 Requires-Dist: sphinxcontrib-htmlhelp>=2.0.0
 Requires-Dist: sphinxcontrib-serializinghtml>=1.1.9
 Requires-Dist: sphinxcontrib-qthelp
-Requires-Dist: Jinja2>=3.0
-Requires-Dist: Pygments>=2.14
-Requires-Dist: docutils>=0.18.1,<0.22
-Requires-Dist: snowballstemmer>=2.0
-Requires-Dist: babel>=2.9
+Requires-Dist: Jinja2>=3.1
+Requires-Dist: Pygments>=2.17
+Requires-Dist: docutils>=0.20,<0.22
+Requires-Dist: snowballstemmer>=2.2
+Requires-Dist: babel>=2.13
 Requires-Dist: alabaster~=0.7.14
 Requires-Dist: imagesize>=1.3
-Requires-Dist: requests>=2.25.0
-Requires-Dist: packaging>=21.0
-Requires-Dist: importlib-metadata>=4.8; python_version < '3.10'
+Requires-Dist: requests>=2.30.0
+Requires-Dist: packaging>=23.0
+Requires-Dist: importlib-metadata>=6.0; python_version < '3.10'
 Requires-Dist: tomli>=2; python_version < '3.11'
-Requires-Dist: colorama>=0.4.5; sys_platform == 'win32'
+Requires-Dist: colorama>=0.4.6; sys_platform == 'win32'
 Requires-Dist: sphinxcontrib-websupport ; extra == "docs"
-Requires-Dist: flake8>=3.5.0 ; extra == "lint"
-Requires-Dist: ruff==0.3.7 ; extra == "lint"
-Requires-Dist: mypy==1.9.0 ; extra == "lint"
-Requires-Dist: sphinx-lint ; extra == "lint"
-Requires-Dist: types-docutils ; extra == "lint"
-Requires-Dist: types-requests ; extra == "lint"
-Requires-Dist: importlib_metadata ; extra == "lint"
-Requires-Dist: tomli ; extra == "lint"
+Requires-Dist: flake8>=6.0 ; extra == "lint"
+Requires-Dist: ruff==0.5.2 ; extra == "lint"
+Requires-Dist: mypy==1.10.1 ; extra == "lint"
+Requires-Dist: sphinx-lint>=0.9 ; extra == "lint"
+Requires-Dist: types-docutils==0.21.0.20240711 ; extra == "lint"
+Requires-Dist: types-requests>=2.30.0 ; extra == "lint"
+Requires-Dist: importlib-metadata>=6.0 ; extra == "lint"
+Requires-Dist: tomli>=2 ; extra == "lint"
 Requires-Dist: pytest>=6.0 ; extra == "lint"
-Requires-Dist: pytest>=6.0 ; extra == "test"
+Requires-Dist: pytest>=8.0 ; extra == "test"
 Requires-Dist: defusedxml>=0.7.1 ; extra == "test"
 Requires-Dist: cython>=3.0 ; extra == "test"
-Requires-Dist: setuptools>=67.0 ; extra == "test"
+Requires-Dist: setuptools>=70.0 ; extra == "test"
+Requires-Dist: typing_extensions>=4.9 ; extra == "test"
 Project-URL: Changelog, https://www.sphinx-doc.org/en/master/changes.html
 Project-URL: Code, https://github.com/sphinx-doc/sphinx
 Project-URL: Download, https://pypi.org/project/Sphinx/