Sphinx 7.4.4__py3-none-any.whl → 7.4.6__py3-none-any.whl

sphinx/__init__.py

@@ -1,6 +1,6 @@
 """The Sphinx documentation toolchain."""
 
-__version__ = '7.4.4'
+__version__ = '7.4.6'
 __display_version__ = __version__  # used for command line version
 
 # Keep this file executable as-is in Python 3!
@@ -27,7 +27,7 @@ warnings.filterwarnings(
 #:
 #: .. versionadded:: 1.2
 #:    Before version 1.2, check the string ``sphinx.__version__``.
-version_info = (7, 4, 4, 'final', 0)
+version_info = (7, 4, 6, 'final', 0)
 
 package_dir = os.path.abspath(os.path.dirname(__file__))
 

sphinx/builders/html/__init__.py

@@ -982,11 +982,10 @@ class StandaloneHTMLBuilder(Builder):
                 matched = pattern
                 sidebars = pat_sidebars
 
-        if len(sidebars) == 0:
-            # keep defaults
-            pass
-
-        ctx['sidebars'] = list(sidebars)
+        # See error_on_html_sidebars_string_values.
+        # Replace with simple list coercion in Sphinx 8.0
+        # xref: RemovedInSphinx80Warning
+        ctx['sidebars'] = sidebars
 
     # --------- these are overwritten by the serialization builder
 
@@ -1287,6 +1286,25 @@ def validate_html_favicon(app: Sphinx, config: Config) -> None:
         config.html_favicon = None
 
 
+def error_on_html_sidebars_string_values(app: Sphinx, config: Config) -> None:
+    """Support removed in Sphinx 2."""
+    errors = {}
+    for pattern, pat_sidebars in config.html_sidebars.items():
+        if isinstance(pat_sidebars, str):
+            errors[pattern] = [pat_sidebars]
+    if not errors:
+        return
+    msg = __("Values in 'html_sidebars' must be a list of strings. "
+             "At least one pattern has a string value: %s. "
+             "Change to `html_sidebars = %r`.")
+    bad_patterns = ', '.join(map(repr, errors))
+    fixed = config.html_sidebars | errors
+    logger.error(msg, bad_patterns, fixed)
+    # Enable hard error in next major version.
+    # xref: RemovedInSphinx80Warning
+    # raise ConfigError(msg % (bad_patterns, fixed))
+
+
 def error_on_html_4(_app: Sphinx, config: Config) -> None:
     """Error on HTML 4."""
     if config.html4_writer:
@@ -1357,6 +1375,7 @@ def setup(app: Sphinx) -> ExtensionMetadata:
     app.connect('config-inited', validate_html_static_path, priority=800)
     app.connect('config-inited', validate_html_logo, priority=800)
     app.connect('config-inited', validate_html_favicon, priority=800)
+    app.connect('config-inited', error_on_html_sidebars_string_values, priority=800)
     app.connect('config-inited', error_on_html_4, priority=800)
     app.connect('builder-inited', validate_math_renderer)
     app.connect('html-page-context', setup_resource_paths)

sphinx/ext/autosummary/generate.py

@@ -330,10 +330,6 @@ def generate_autosummary_content(
                     doc, app, obj, {'module'}, imported=True
                 )
                 skip += all_imported_modules
-                imported_modules = [name + '.' + modname for modname in imported_modules]
-                all_imported_modules = [
-                    name + '.' + modname for modname in all_imported_modules
-                ]
                 public_members = getall(obj)
             else:
                 imported_modules, all_imported_modules = [], []
@@ -476,21 +472,22 @@ def _get_modules(
         if modname in skip:
             # module was overwritten in __init__.py, so not accessible
             continue
-        fullname = name + '.' + modname
+        fullname = f'{name}.{modname}'
         try:
             module = import_module(fullname)
-            if module and hasattr(module, '__sphinx_mock__'):
-                continue
         except ImportError:
             pass
+        else:
+            if module and hasattr(module, '__sphinx_mock__'):
+                continue
 
-        items.append(fullname)
+        items.append(modname)
         if public_members is not None:
             if modname in public_members:
-                public.append(fullname)
+                public.append(modname)
         else:
             if not modname.startswith('_'):
-                public.append(fullname)
+                public.append(modname)
     return public, items
 
 

sphinx/ext/autosummary/templates/autosummary/module.rst

@@ -3,7 +3,7 @@
 .. automodule:: {{ fullname }}
 
    {% block attributes %}
-   {% if attributes %}
+   {%- if attributes %}
    .. rubric:: {{ _('Module Attributes') }}
 
    .. autosummary::
@@ -11,10 +11,10 @@
       {{ item }}
    {%- endfor %}
    {% endif %}
-   {% endblock %}
+   {%- endblock %}
 
-   {% block functions %}
-   {% if functions %}
+   {%- block functions %}
+   {%- if functions %}
    .. rubric:: {{ _('Functions') }}
 
    .. autosummary::
@@ -22,10 +22,10 @@
       {{ item }}
    {%- endfor %}
    {% endif %}
-   {% endblock %}
+   {%- endblock %}
 
-   {% block classes %}
-   {% if classes %}
+   {%- block classes %}
+   {%- if classes %}
    .. rubric:: {{ _('Classes') }}
 
    .. autosummary::
@@ -33,10 +33,10 @@
       {{ item }}
    {%- endfor %}
    {% endif %}
-   {% endblock %}
+   {%- endblock %}
 
-   {% block exceptions %}
-   {% if exceptions %}
+   {%- block exceptions %}
+   {%- if exceptions %}
    .. rubric:: {{ _('Exceptions') }}
 
    .. autosummary::
@@ -44,10 +44,10 @@
       {{ item }}
    {%- endfor %}
    {% endif %}
-   {% endblock %}
+   {%- endblock %}
 
-{% block modules %}
-{% if modules %}
+{%- block modules %}
+{%- if modules %}
 .. rubric:: Modules
 
 .. autosummary::
@@ -57,4 +57,4 @@
    {{ item }}
 {%- endfor %}
 {% endif %}
-{% endblock %}
+{%- endblock %}

sphinx/ext/todo.py

@@ -215,6 +215,9 @@ def latex_visit_todo_node(self: LaTeXTranslator, node: todo_node) -> None:
         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
+        if self.table:
+            self.table.has_problematic = True
         node.pop(0)
     else:
         raise nodes.SkipNode
@@ -222,6 +225,7 @@ def latex_visit_todo_node(self: LaTeXTranslator, node: todo_node) -> None:
 
 def latex_depart_todo_node(self: LaTeXTranslator, node: todo_node) -> None:
     self.body.append('\\end{sphinxtodo}\n')
+    self.no_latex_floats -= 1
 
 
 def setup(app: Sphinx) -> ExtensionMetadata:

sphinx/texinputs/sphinxlatextables.sty

@@ -108,6 +108,7 @@
     \vbox{}% get correct baseline from above
     \LTpre\z@skip\LTpost\z@skip % set to zero longtable's own skips
     \edef\sphinxbaselineskip{\dimexpr\the\dimexpr\baselineskip\relax\relax}%
+    \spx@inframedtrue % message to sphinxheavybox
    }%
 % Compatibility with caption package
 \def\sphinxthelongtablecaptionisattop{%
@@ -121,7 +122,9 @@
 \def\sphinxatlongtableend{\@nobreakfalse % latex3/latex2e#173
     \prevdepth\z@\vskip\sphinxtablepost\relax}%
 % B. Table with tabular or tabulary
-\def\sphinxattablestart{\par\vskip\dimexpr\sphinxtablepre\relax}%
+\def\sphinxattablestart{\par\vskip\dimexpr\sphinxtablepre\relax
+                        \spx@inframedtrue % message to sphinxheavybox
+                        }%
 \let\sphinxattableend\sphinxatlongtableend
 % This is used by tabular and tabulary templates
 \newcommand*\sphinxcapstartof[1]{%

sphinx/util/inventory.py

@@ -172,8 +172,8 @@ class InventoryFile:
             inv_item: InventoryItem = projname, version, location, dispname
             invdata.setdefault(type, {})[name] = inv_item
         for ambiguity in actual_ambiguities:
-            logger.warning(__("inventory <%s> contains multiple definitions for %s"),
-                           uri, ambiguity, type='intersphinx',  subtype='external')
+            logger.info(__("inventory <%s> contains multiple definitions for %s"),
+                        uri, ambiguity, type='intersphinx',  subtype='external')
         return invdata
 
     @classmethod

sphinx/writers/latex.py

@@ -306,6 +306,7 @@ class LaTeXTranslator(SphinxTranslator):
         self.in_term = 0
         self.needs_linetrimming = 0
         self.in_minipage = 0
+        # only used by figure inside an admonition
         self.no_latex_floats = 0
         self.first_document = 1
         self.this_is_the_title = 1
@@ -966,11 +967,15 @@ class LaTeXTranslator(SphinxTranslator):
     def visit_seealso(self, node: Element) -> None:
         self.body.append(BLANKLINE)
         self.body.append(r'\begin{sphinxseealso}{%s:}' % admonitionlabels['seealso'] + CR)
+        self.no_latex_floats += 1
+        if self.table:
+            self.table.has_problematic = True
 
     def depart_seealso(self, node: Element) -> None:
         self.body.append(BLANKLINE)
         self.body.append(r'\end{sphinxseealso}')
         self.body.append(BLANKLINE)
+        self.no_latex_floats -= 1
 
     def visit_rubric(self, node: nodes.rubric) -> None:
         if len(node) == 1 and node.astext() in ('Footnotes', _('Footnotes')):
@@ -1512,6 +1517,8 @@ class LaTeXTranslator(SphinxTranslator):
         if self.no_latex_floats:
             align = "H"
         if self.table:
+            # Blank line is needed if text precedes
+            self.body.append(BLANKLINE)
             # TODO: support align option
             if 'width' in node:
                 length = self.latex_image_length(node['width'])
@@ -1580,6 +1587,8 @@ class LaTeXTranslator(SphinxTranslator):
     def visit_admonition(self, node: Element) -> None:
         self.body.append(CR + r'\begin{sphinxadmonition}{note}')
         self.no_latex_floats += 1
+        if self.table:
+            self.table.has_problematic = True
 
     def depart_admonition(self, node: Element) -> None:
         self.body.append(r'\end{sphinxadmonition}' + CR)
@@ -1590,6 +1599,8 @@ class LaTeXTranslator(SphinxTranslator):
         self.body.append(CR + r'\begin{sphinxadmonition}{%s}{%s:}' %
                          (node.tagname, label))
         self.no_latex_floats += 1
+        if self.table:
+            self.table.has_problematic = True
 
     def _depart_named_admonition(self, node: Element) -> None:
         self.body.append(r'\end{sphinxadmonition}' + CR)

{sphinx-7.4.4.dist-info → sphinx-7.4.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Sphinx
-Version: 7.4.4
+Version: 7.4.6
 Summary: Python documentation generator
 Author-email: Georg Brandl <georg@python.org>
 Requires-Python: >=3.9

{sphinx-7.4.4.dist-info → sphinx-7.4.6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-sphinx/__init__.py,sha256=rQisav1KDhuasqIZKggouqZKK_GxVoyJwW-MUUIH2MM,1690
+sphinx/__init__.py,sha256=L0jzbPHxzSdBVmC-QfTfKvwdk3Mcz0s-A7JmZ-rLvP8,1690
 sphinx/__main__.py,sha256=wIifwXlZHdi4gtQmkJ6KF0BsflvD9o0Wd5nARTdJc8A,127
 sphinx/addnodes.py,sha256=EQTIi9Zta6DaNa-2WGE3l9AVjdp7WzwwrfwRnax8vXE,18707
 sphinx/application.py,sha256=5QXM7tYRt1s4q00GHPtAK2EIxu6G_UkzMB3MOKOkuUI,57793
@@ -35,7 +35,7 @@ sphinx/builders/singlehtml.py,sha256=mYsB_J5AOi7wEswNbH0v5XXZnmZkBmLRHJaQtz_nB-c
 sphinx/builders/texinfo.py,sha256=cROws1DmYPp4-_uD62Ryu7Vn5Kv-JYIH1YCCm-_SRWU,9804
 sphinx/builders/text.py,sha256=YCNWggEL5GCjh5lQLT8z_NgVZdMYAHtAHfGAoUAvT0w,2996
 sphinx/builders/xml.py,sha256=SIblnQLGGzTPTv4xnFFy-Sf66YxP9q1n-28yoVajWhA,3901
-sphinx/builders/html/__init__.py,sha256=8xuYeo0zHsOjzlDznGbf4sxz_5wbBZuVButlhOBSWGc,58940
+sphinx/builders/html/__init__.py,sha256=6xiPEQD9dlUZnnrEr7pJnwCPBxqlyZ-Jf9QjJ4f9LKk,59861
 sphinx/builders/html/_assets.py,sha256=9GhVCpJDTD17WzZavhONH9kqOEGS9glD62kBQ16jLeA,5599
 sphinx/builders/html/transforms.py,sha256=DhIabbXbvZM8lrT9AvKJb9JoawsmEt__DhpoeXA8Yvw,2597
 sphinx/builders/latex/__init__.py,sha256=fQvWHt7EuFFQBghaD2_TCwEBaheQKkFbxKu9GIP4lWU,24497
@@ -99,7 +99,7 @@ sphinx/ext/imgmath.py,sha256=01mzOdmIDy5PpS8PT9pErrVfK-Ef9We-czpPCyObicc,15550
 sphinx/ext/inheritance_diagram.py,sha256=ocxm7JADD3_Ed43jK-LtawoRfO6IowjIGqJU-U7L83g,17490
 sphinx/ext/linkcode.py,sha256=x4Ku-cssPT771pj5Rp966kPSK20hq06O9pf03asl2lk,2352
 sphinx/ext/mathjax.py,sha256=ezbvP5pqDlTHhNwhGHj_sbquVLLqM2_8Th5YMIqIOWU,5408
-sphinx/ext/todo.py,sha256=_vYZ43QbKVdhvHpNsUXRcu26hLPVFkLEEmpaICU-hMg,8194
+sphinx/ext/todo.py,sha256=xjoaguKakr0Xe6IMZASlCRD7YAlqCaHnK8KYtNL7Z-U,8327
 sphinx/ext/viewcode.py,sha256=KwmggBvSO0OK9w-WHDPKzG3SLsYNdN9xuJkb7xl8goQ,13792
 sphinx/ext/autodoc/__init__.py,sha256=aGYSAMwuGYQvIDNp365m7DM839yhn4wu-NfKEKzgktQ,116920
 sphinx/ext/autodoc/directive.py,sha256=IqDLJnc91_SxqlQkBR2yGoK_ewTzCjGwozCY0eP5HHY,5833
@@ -109,10 +109,10 @@ sphinx/ext/autodoc/preserve_defaults.py,sha256=eimSeG8656Z9KpCTuOKmbbASWLIDLbVUk
 sphinx/ext/autodoc/type_comment.py,sha256=FclaU566JP0ly2k0XupMi9efnBKWiW1Zoc9L1cQdliI,5422
 sphinx/ext/autodoc/typehints.py,sha256=LIO8sgLCCdvJAnmM5OSPQQHStwUa5igjZgnu803Fy4Q,7973
 sphinx/ext/autosummary/__init__.py,sha256=L3EoGQX_URQRh-ap_Kde6d6oGrByYqkSn5uBCAdWWpo,31862
-sphinx/ext/autosummary/generate.py,sha256=Eal-e67qHkJTlt6oAkTr-9LnorMujJIB8pqkYxkWHy8,28415
+sphinx/ext/autosummary/generate.py,sha256=q0n46AAiwCAwELSZ-pecEvL8OJFpLp3CISDKlXMMQkU,28199
 sphinx/ext/autosummary/templates/autosummary/base.rst,sha256=AfG9oeDMTKBsBf2lUKr-NolOeV7ImT_JrKG3KQkEGzE,106
 sphinx/ext/autosummary/templates/autosummary/class.rst,sha256=1uu4SSX9KRCeNlcr7FMRZ-DrPuW7E6tQ7QZC1asnAL0,553
-sphinx/ext/autosummary/templates/autosummary/module.rst,sha256=vF13Kh9MiXnAoqer8SWcKjY9TutSm7nEcUerqEAMtdo,1071
+sphinx/ext/autosummary/templates/autosummary/module.rst,sha256=HuEHeghiPzJ5jgDNy3_3vZ7De-AtWZjgYx_57LrP9tM,1085
 sphinx/ext/intersphinx/__init__.py,sha256=olSC7q5eSOaQ_hFv_YRMlUd4fVFzMaotspUCfc198_U,2675
 sphinx/ext/intersphinx/__main__.py,sha256=zapvRzIUEUskvRfaYkf0okrNxPVL2rMWso4NvHOsz7g,218
 sphinx/ext/intersphinx/_cli.py,sha256=pcq57fnqtKa_MO3Hl4KbvkKsaDhyJofYqrKVcQh_WeQ,1440
@@ -433,7 +433,7 @@ sphinx/texinputs/sphinxlatexshadowbox.sty,sha256=WOPHKtiNfv3vDun8N7ziIxprd0Dk_G2
 sphinx/texinputs/sphinxlatexstyleheadings.sty,sha256=jDiLn0iEnclKADiAqjLoxdpyhu_MgwQETOWDgSkMO7c,3445
 sphinx/texinputs/sphinxlatexstylepage.sty,sha256=fGUYalNjMZq6HTFzP1-3c5VhUfZ63LhSo48Q4F6GyK8,3064
 sphinx/texinputs/sphinxlatexstyletext.sty,sha256=tbEMGqHjTVXW7PVzTNNcpzi3tFQPFcXqCSxQcjOs53c,6881
-sphinx/texinputs/sphinxlatextables.sty,sha256=snOD2ExsHU7c1AyNFLUs3vl8tVroJ4QM_YOK0cmQdpE,57499
+sphinx/texinputs/sphinxlatextables.sty,sha256=TLXNR5Ua92ZK1M2Mkohb7WLVicB4iYE6yj5DvhqniTs,57644
 sphinx/texinputs/sphinxmanual.cls,sha256=XyBvfQQOEbjSXnY6ckCDRUFou2TzEikpMCZSfA2XX-o,4241
 sphinx/texinputs/sphinxoptionsgeometry.sty,sha256=D2pTqE7L4wwt-UqbTZWySUksJ1Yj12YSjHv36E9tJOA,2061
 sphinx/texinputs/sphinxoptionshyperref.sty,sha256=wuvlb09FedUwCyOAzup8_iuabDeaffIFwVFcg_mC-BY,1094
@@ -561,7 +561,7 @@ sphinx/util/i18n.py,sha256=K5smw0FQ3Hkr4Bp17o2BQRMK-8s76edJPsdWgLT5AFM,10542
 sphinx/util/images.py,sha256=Y5Oy1M_BD6HRsUyWFQ2DvvCL4VDOFHDPZxtYnO8QEfM,3701
 sphinx/util/index_entries.py,sha256=wEa55m_tez3UFNFEVuIesEQKWavANQ2O-l86k1If0sY,986
 sphinx/util/inspect.py,sha256=BdltEA-0lZKhCcCa3DmS7kIV7Xf5KZS6d8VKf6uLNMI,33077
-sphinx/util/inventory.py,sha256=qjbSlk51LQY2gXZW_d8i3-pyUewisaFpj955jf2IFz0,7973
+sphinx/util/inventory.py,sha256=Mo9JGfs-4hFv8l94-w53L5uarrSMdWiagPCWjCeafI4,7967
 sphinx/util/logging.py,sha256=WokXNrpfjX7kekEE6N59MitS23DzdCpyEw0GTiQovug,20542
 sphinx/util/matching.py,sha256=pywT5EKjUUJ-PX4H6mm-LA3f37AvYfxwEpraHHrhVsI,5368
 sphinx/util/math.py,sha256=GuBqbvunQfOE2JpxjFsUoWwujDhWaYELczJIyNGzLhE,1984
@@ -579,13 +579,13 @@ sphinx/util/typing.py,sha256=nSZtWgMw4IqRkjplxPANTlTd7Nj5hvUrT6VLVqThO9M,22617
 sphinx/writers/__init__.py,sha256=efGdnx4MWlPEDzXACf4Q18Oi3GTyY5Ob14I_j3XXtXc,31
 sphinx/writers/html.py,sha256=ptitqWUkA4wnY0HuPIjy1GuKG4cOPCuPlAdH7aMRhyg,1604
 sphinx/writers/html5.py,sha256=KmE-WAPcIX1laEHXBX2H8zRwCDC66vGzys_32UV5yM4,37671
-sphinx/writers/latex.py,sha256=n4TNdWkLcdctaKMH85HPAvqhGiTewW83wgz9pl4uT90,92241
+sphinx/writers/latex.py,sha256=rJLo1X-4cMuP-uC_-RJ_4jjtSRYs1S2MwNCT1dJOafg,92659
 sphinx/writers/manpage.py,sha256=iLoC4i81W52dTl8Kpug65CV1M7cCz1buGgsN7FhazYo,16215
 sphinx/writers/texinfo.py,sha256=UU3Zrt-zBgdwYgqj4BJFNthggzMr_Gllx2ewBeWrkcI,53451
 sphinx/writers/text.py,sha256=HEiYXsWXO9QVOazg2V3D0ehGTnK38dAtYP9v0rst684,42964
 sphinx/writers/xml.py,sha256=NyDl82hCFSRiHrCZV6vBfn4AsAyXH6khtSJEfhOX8a0,1502
-sphinx-7.4.4.dist-info/entry_points.txt,sha256=KU_c9jqXj7yyZylSz11XRIXG3gAZApQa0d5DmcfyA7M,188
-sphinx-7.4.4.dist-info/LICENSE.rst,sha256=HdZPUFcmQaLySBc9fKvRC5aOUNkxL9Gz5py0p6XGDk4,3135
-sphinx-7.4.4.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-sphinx-7.4.4.dist-info/METADATA,sha256=PSou9ENgREao62zCI8w7DVwEM19axj7bP3FBqVVawDU,6113
-sphinx-7.4.4.dist-info/RECORD,,
+sphinx-7.4.6.dist-info/entry_points.txt,sha256=KU_c9jqXj7yyZylSz11XRIXG3gAZApQa0d5DmcfyA7M,188
+sphinx-7.4.6.dist-info/LICENSE.rst,sha256=HdZPUFcmQaLySBc9fKvRC5aOUNkxL9Gz5py0p6XGDk4,3135
+sphinx-7.4.6.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+sphinx-7.4.6.dist-info/METADATA,sha256=CvuHVqocZr1i5bNql51QIW9JtCIuLJ9Q0HcpyYRaQe4,6113
+sphinx-7.4.6.dist-info/RECORD,,