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

sphinx/__init__.py

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

sphinx/builders/__init__.py

@@ -59,14 +59,20 @@ class Builder:
     Builds target formats from the reST sources.
     """
 
-    #: The builder's name, for the -b command line option.
-    name = ''
+    #: The builder's name.
+    #: This is the value used to select builders on the command line.
+    name: str = ''
     #: The builder's output format, or '' if no document output is produced.
-    format = ''
-    #: The message emitted upon successful build completion. This can be a
-    #: printf-style template string with the following keys: ``outdir``,
-    #: ``project``
-    epilog = ''
+    #: This is commonly the file extension, e.g. "html",
+    #: though any string value is accepted.
+    #: The builder's format string can be used by various components
+    #: such as :class:`.SphinxPostTransform` or extensions to determine
+    #: their compatibility with the builder.
+    format: str = ''
+    #: The message emitted upon successful build completion.
+    #: This can be a printf-style template string
+    #: with the following keys: ``outdir``, ``project``
+    epilog: str = ''
 
     #: default translator class for the builder.  This can be overridden by
     #: :py:meth:`~sphinx.application.Sphinx.set_translator`.
@@ -74,8 +80,8 @@ class Builder:
     # doctree versioning method
     versioning_method = 'none'
     versioning_compare = False
-    #: allow parallel write_doc() calls
-    allow_parallel = False
+    #: Whether it is safe to make parallel :meth:`~.Builder.write_doc()` calls.
+    allow_parallel: bool = False
     # support translation
     use_message_catalog = True
 
@@ -83,9 +89,9 @@ class Builder:
     #: Image files are searched in the order in which they appear here.
     supported_image_types: list[str] = []
     #: The builder can produce output documents that may fetch external images when opened.
-    supported_remote_images = False
+    supported_remote_images: bool = False
     #: The file format produced by the builder allows images to be embedded using data-URIs.
-    supported_data_uri_images = False
+    supported_data_uri_images: bool = False
 
     def __init__(self, app: Sphinx, env: BuildEnvironment) -> None:
         self.srcdir = app.srcdir
@@ -159,7 +165,7 @@ class Builder:
     def get_relative_uri(self, from_: str, to: str, typ: str | None = None) -> str:
         """Return a relative URI between two source filenames.
 
-        May raise environment.NoUri if there's no way to return a sensible URI.
+        :raises: :exc:`!NoUri` if there's no way to return a sensible URI.
         """
         return relative_uri(
             self.get_target_uri(from_),
@@ -789,7 +795,16 @@ class Builder:
         pass
 
     def write_doc(self, docname: str, doctree: nodes.document) -> None:
-        """Where you actually write something to the filesystem."""
+        """
+        Write the output file for the document
+
+        :param docname: the :term:`docname <document name>`.
+        :param doctree: defines the content to be written.
+
+        The output filename must be determined within this method,
+        typically by calling :meth:`~.Builder.get_target_uri`
+        or :meth:`~.Builder.get_relative_uri`.
+        """
         raise NotImplementedError
 
     def write_doc_serialized(self, docname: str, doctree: nodes.document) -> None:

sphinx/environment/__init__.py

@@ -54,10 +54,6 @@ default_settings: dict[str, Any] = {
     'image_loading': 'link',
     'embed_stylesheet': False,
     'cloak_email_addresses': True,
-    'cve_base_url': 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-',
-    'cve_references': None,
-    'cwe_base_url': 'https://cwe.mitre.org/data/definitions/',
-    'cwe_references': None,
     'pep_base_url': 'https://peps.python.org/',
     'pep_references': None,
     'rfc_base_url': 'https://datatracker.ietf.org/doc/html/',

sphinx/roles.py

@@ -17,6 +17,7 @@ from sphinx.util.docutils import ReferenceRole, SphinxRole
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
+    from typing import Final
 
     from docutils.nodes import Element, Node, TextElement, system_message
 
@@ -197,6 +198,8 @@ class AnyXRefRole(XRefRole):
 
 
 class CVE(ReferenceRole):
+    _BASE_URL: Final = 'https://www.cve.org/CVERecord?id=CVE-'
+
     def run(self) -> tuple[list[Node], list[system_message]]:
         target_id = f'index-{self.env.new_serialno("index")}'
         entries = [
@@ -233,14 +236,15 @@ class CVE(ReferenceRole):
         return [index, target, reference], []
 
     def build_uri(self) -> str:
-        base_url = self.inliner.document.settings.cve_base_url
         ret = self.target.split('#', 1)
         if len(ret) == 2:
-            return f'{base_url}{ret[0]}#{ret[1]}'
-        return f'{base_url}{ret[0]}'
+            return f'{CVE._BASE_URL}{ret[0]}#{ret[1]}'
+        return f'{CVE._BASE_URL}{ret[0]}'
 
 
 class CWE(ReferenceRole):
+    _BASE_URL: Final = 'https://cwe.mitre.org/data/definitions/'
+
     def run(self) -> tuple[list[Node], list[system_message]]:
         target_id = f'index-{self.env.new_serialno("index")}'
         entries = [
@@ -277,11 +281,10 @@ class CWE(ReferenceRole):
         return [index, target, reference], []
 
     def build_uri(self) -> str:
-        base_url = self.inliner.document.settings.cwe_base_url
         ret = self.target.split('#', 1)
         if len(ret) == 2:
-            return f'{base_url}{int(ret[0])}.html#{ret[1]}'
-        return f'{base_url}{int(ret[0])}.html'
+            return f'{CWE._BASE_URL}{int(ret[0])}.html#{ret[1]}'
+        return f'{CWE._BASE_URL}{int(ret[0])}.html'
 
 
 class PEP(ReferenceRole):

sphinx/texinputs/sphinx.sty

@@ -9,7 +9,7 @@
 % by the Sphinx LaTeX writer.
 
 \NeedsTeXFormat{LaTeX2e}[1995/12/01]
-\ProvidesPackage{sphinx}[2024/07/28 v8.1.0 Sphinx LaTeX package (sphinx-doc)]
+\ProvidesPackage{sphinx}[2024/10/11 v8.1.1 Sphinx LaTeX package (sphinx-doc)]
 
 % provides \ltx@ifundefined
 % (many packages load ltxcmds: graphicx does for pdftex and lualatex but
@@ -885,15 +885,12 @@
   {\DeclareStringOption[fontawesome]{iconpackage}}
   {\DeclareStringOption[none]{iconpackage}}%
 }%
-\newcommand\spx@faIcon[3][]{}%
-% The hacky definition of \spx@faIcon above is to let it by default swallow
-% the icon macro and the \sphinxtitlerowaftericonspacecmd (see
-% \sphinxdotitlerowwithicon in sphinxlatexadmonitions.sty) which inserts
-% a space between it and title.  See how \spx@faIcon is used below.
-%
-% If user sets a title-icon key to some LaTeX code of their own, of course
-% \spx@faIcon is not executed and the inserted space will thus be there, as
-% expected.
+\newcommand\spx@faIcon[2][]{}%
+% The above \spx@faIcon which gobbles one mandatory and one optional
+% argument is put into use only if both fontawesome5 and fontawesome
+% LaTeX packages are not available, as part of the defaults for the
+% div.*_title-icon keys (these keys can be redefined via the sphinxsetup
+% interface).
 %
 \def\spxstring@fontawesome{fontawesome}
 \def\spxstring@fontawesomev{fontawesome5}
@@ -920,8 +917,8 @@
                    \let\faicon@pen\faPencil
               \fi
           % if neither has been required, \spx@faIcon will simply swallow
-          % its argument (and follwing space macro) and it is up to user
-          % to set the keys appropriately.
+          % its argument and it is up to user
+          % to set the various div.*_title-icon keys appropriately.
           \fi\fi %
          }%
          {%

sphinx/texinputs/sphinxlatexadmonitions.sty

@@ -1,7 +1,7 @@
 %% NOTICES AND ADMONITIONS
 %
 % change this info string if making any custom modification
-\ProvidesPackage{sphinxlatexadmonitions}[2024/07/28 v8.1.0 admonitions]
+\ProvidesPackage{sphinxlatexadmonitions}[2024/10/11 v8.1.1 admonitions]
 
 % Provides support for this output mark-up from Sphinx latex writer:
 %
@@ -341,9 +341,11 @@
          \ifdim\wd\z@>\z@
           \textcolor{sphinx#1TtlFgColor}{%
             \@nameuse{sphinx#1TtlIcon}%
-            % This macro is located here and not after the closing brace
-            % for reasons of fall-back \spx@faIcon definition in sphinx.sty
-            % in case fontawesome5 package not found.
+            % The next macro is located here for legacy reasons of earlier
+            % functioning of \spx@faIcon.  When fontawesome{5,}.sty both
+            % are unavailable, it (formerly) gobbled this next macro.
+            % We leave it here now although it could be moved to after
+            % the closing brace.
             \sphinxtitlerowaftericonspacecmd
           }%
          \fi

sphinx/util/__init__.py

@@ -8,6 +8,7 @@ import posixpath
 import re
 from typing import Any
 
+from sphinx.errors import ExtensionError as _ExtensionError
 from sphinx.errors import FiletypeNotFoundError
 from sphinx.util import _files, _importer, logging
 from sphinx.util import index_entries as _index_entries
@@ -86,6 +87,7 @@ _DEPRECATED_OBJECTS: dict[str, tuple[Any, str, tuple[int, int]]] = {
         'sphinx.util.index_entries.split_into',
         (9, 0),
     ),
+    'ExtensionError': (_ExtensionError, 'sphinx.errors.ExtensionError', (9, 0)),
     'md5': (_md5, '', (9, 0)),
     'sha1': (_sha1, '', (9, 0)),
     'import_object': (_importer.import_object, '', (10, 0)),

{sphinx-8.1.0.dist-info → sphinx-8.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Sphinx
-Version: 8.1.0
+Version: 8.1.2
 Summary: Python documentation generator
 Author-email: Georg Brandl <georg@python.org>
 Requires-Python: >=3.10
@@ -80,6 +80,7 @@ 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: Documentation, https://www.sphinx-doc.org/
 Project-URL: Download, https://pypi.org/project/Sphinx/
 Project-URL: Homepage, https://www.sphinx-doc.org/
 Project-URL: Issue tracker, https://github.com/sphinx-doc/sphinx/issues

{sphinx-8.1.0.dist-info → sphinx-8.1.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-sphinx/__init__.py,sha256=OhECOWcGcaYrjAs8UhiPG6OVbZa6gWqseZAfjC6VoqU,1703
+sphinx/__init__.py,sha256=-2svNZt_Ib-y3gkKkZ3ti6x3Qn-WSHESCMrFZgyxPhA,1703
 sphinx/__main__.py,sha256=wIifwXlZHdi4gtQmkJ6KF0BsflvD9o0Wd5nARTdJc8A,127
 sphinx/addnodes.py,sha256=EQTIi9Zta6DaNa-2WGE3l9AVjdp7WzwwrfwRnax8vXE,18707
 sphinx/application.py,sha256=j1EjhSnXce7HcgHeRGfDrhOuMCs2Ha-0TRfVMmq9SQ8,65788
@@ -15,14 +15,14 @@ sphinx/project.py,sha256=8jf0rDETXDA4_4pYNXfQ8dqLlKoKBQSe4SSGSgVHGbA,4570
 sphinx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sphinx/pygments_styles.py,sha256=4ube8wmrKx-Luigixj-odhVb8RqDf_3R0u2Cgsqk8t4,2586
 sphinx/registry.py,sha256=gphep-zWqZ4W_CpFbrnm18BDXTBRL4QzSVYHSdx0dBw,22898
-sphinx/roles.py,sha256=hIECVpqF_UCDwLqF__eptGS-8lejrFWbJ48M1Jl_FwA,20891
+sphinx/roles.py,sha256=JLureyhoE67-zj7offy8WJpvpLPz2qWv-WFnqxUl08s,20944
 sphinx/theming.py,sha256=nAu6quZhsM8jU1__BkT0xH_axwwDFVJKxDRxntnj3ag,19997
 sphinx/versioning.py,sha256=pvzL18Sz0UMwixvGg65IneuaMNtmgl_cVSCQ4MxJ_vw,6246
 sphinx/_cli/__init__.py,sha256=AWTELmWU_5J7uiuNQYi1mQfH483Z0ZYeYonNdmb5O9A,9982
 sphinx/_cli/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sphinx/_cli/util/colour.py,sha256=M04FGs_3Dpet0SmIyRg8I7gKbta8mfAGMObocgZX5N8,2997
 sphinx/_cli/util/errors.py,sha256=_3YWZbr0vItrMcZ0zsLr2IqaCEEkJf4lmNhKO7AH5UI,4852
-sphinx/builders/__init__.py,sha256=ePfyqt-laqx10df6upr6w9J9Jkpg2EV2dVQD2HkO7mM,31848
+sphinx/builders/__init__.py,sha256=0lDANXVqejGXYL0dF1BPy0IzJ_FUHPUWEMt7dwhMpvs,32542
 sphinx/builders/_epub_base.py,sha256=-FGIGZ-4Cu3KWqeb2QfprBKl6x7REt5i4uJvBEwZVeE,29848
 sphinx/builders/changes.py,sha256=Izkn2P-EZnMtEn3LXes8ho2SvY7XrUaPBdJVjaUGejk,6958
 sphinx/builders/dirhtml.py,sha256=knJB8YAxmOj4mOx5AWpqbDxs-QVPJpZpsjuEvRzAdqg,1552
@@ -76,7 +76,7 @@ sphinx/domains/python/__init__.py,sha256=K5-RSG0_u_hhvmKj9M_lN9JPgH8bIJ90LRdn93N
 sphinx/domains/python/_annotations.py,sha256=cO7U8JvRcKX1CObNlZrO57UcuhfTNRnczOHmVZiMixo,23388
 sphinx/domains/python/_object.py,sha256=DMEhPh_iOy5Cps637KVNuyuRDVBs1XFdWD99ujRRwJY,17018
 sphinx/domains/std/__init__.py,sha256=m8yHdbEn75p7YcVzmJn8ihEcX8h-RPgKg7tjuUd1l_w,49494
-sphinx/environment/__init__.py,sha256=RfPu9lngh35yOyIV6gZoL4uOMQutns-fI__25B7aaQQ,32699
+sphinx/environment/__init__.py,sha256=oTgkI2qqUOMw4EcuyZNMJJ66ILqPdYm0khqX-l_ikgs,32505
 sphinx/environment/adapters/__init__.py,sha256=VnDotW2UbxjWeVITmz7iTsVrzqQcvmLHr3euKqqKHwo,34
 sphinx/environment/adapters/asset.py,sha256=6-jxJqm8DcOJ0CIqPFal88m6New3aYHK3K0dWrrwy64,480
 sphinx/environment/adapters/indexentries.py,sha256=nSfXBe47CoUzz26DEFb3RzewKVBbmv5S6kdmdbKeay4,9788
@@ -419,10 +419,10 @@ sphinx/texinputs/latexmkjarc.jinja,sha256=MAEuOfgjE56gBm5tt9pr3x1dLkaYQRVvtLKKOy
 sphinx/texinputs/latexmkrc.jinja,sha256=CaSKfWWrcA-l0BMSxa8h3YFf-C_hMjsNs2fe5Z9XEwA,1104
 sphinx/texinputs/make.bat.jinja,sha256=ZgR_dDOU01AT_VFmD4L97dbpTDSUGHksLjVfTmBj2gg,1041
 sphinx/texinputs/python.ist,sha256=G47jS0AbTU91qQ7ZEo8qwX7rGAIiyyV1DlLPaO_wIVE,392
-sphinx/texinputs/sphinx.sty,sha256=R3T5VRdvuDzK5dP5PnbGlvQEBAL3Kh54I2vzcMtfAH4,54273
+sphinx/texinputs/sphinx.sty,sha256=8JY_4h7EZJV1RhH2H6KirI3zBH5w5_2q5vSl8mT0wDM,54119
 sphinx/texinputs/sphinx.xdy,sha256=QWncK0Ie81AneS7M6R0kbOYv2tebzm1jluAXYnxS4b4,9475
 sphinx/texinputs/sphinxhowto.cls,sha256=IzFjVXa79iEvsI5q4sUCEcdyYE2gMbXIh50gt9QYCI8,3256
-sphinx/texinputs/sphinxlatexadmonitions.sty,sha256=Pw5j5HdTsUd2B7fpAhls3LlCxR4w7rOJyReKk546AWQ,18991
+sphinx/texinputs/sphinxlatexadmonitions.sty,sha256=193TM6nSTdVQ2rNXgoFJukl1UoF5kh-Sil6AWozhobg,19110
 sphinx/texinputs/sphinxlatexcontainers.sty,sha256=_j93wx3CLRDr5uMO7OOWaeCKHsDEN5h-K-0H9kgaNoU,900
 sphinx/texinputs/sphinxlatexgraphics.sty,sha256=BGG4zRnsJ3w2d2OgWjhSHG5qOsOO9bmCjIHRv2rYUVY,4918
 sphinx/texinputs/sphinxlatexindbibtoc.sty,sha256=Erde_bnrAsJBt42eQD3IZ_5L5iPmscXIDZ6mGRK6b6s,2065
@@ -545,7 +545,7 @@ sphinx/transforms/references.py,sha256=AyYHJcv4mPfrCdD7kKn-2oLSP8oxh6GJ8rjgahVYB
 sphinx/transforms/post_transforms/__init__.py,sha256=zIroXaSf1wQb31I71TqaaQIZjW7ZbMicNuU0RC0WvBg,13086
 sphinx/transforms/post_transforms/code.py,sha256=1jUfLRdmoHJkMFbAvyY4XD5CBghZUTAouQydA_ttCk0,4496
 sphinx/transforms/post_transforms/images.py,sha256=qpUVLkjlSKzb_IzKoRXTc_Xxn6OnwizJrg45QmEb4QU,10790
-sphinx/util/__init__.py,sha256=sIasAvJMElWYQs3XkV45Wsi9mvHS4S8f9truPnSAAbU,3192
+sphinx/util/__init__.py,sha256=nTGTyMcQhKYmu2kRLZNr23UwrYjKR7Fkef71jx0Wt9c,3333
 sphinx/util/_files.py,sha256=iKEaNsz9mxspOX_F1XLmsVdBssSlCxcizTsNVdmVgaQ,2666
 sphinx/util/_importer.py,sha256=qqQWn2TAGY6FS0WJ8aDjFnUdhadDX7hVavJYEs_CAZo,885
 sphinx/util/_io.py,sha256=-KaagsRCwlKg8lpHJBf3KqCc_GD8r8BDS_veph3VTrA,894
@@ -591,8 +591,8 @@ sphinx/writers/manpage.py,sha256=R0S02xJ0YdDZ3IPh-8po5qHOPWy5bciiOpesGF9-yC8,163
 sphinx/writers/texinfo.py,sha256=-b5PgRRuoGF51OS8Gbz3hV-iA-swjT2T552tb5Bkg_4,53082
 sphinx/writers/text.py,sha256=jXEXXXCyFFLXGKatrdxipgX3cJP9Wc4-X01SQFmJAYo,43426
 sphinx/writers/xml.py,sha256=5HXyJd1sRRzY3p3sE-_esSYlQjhtW9TU6yrRPv2Uoy0,1563
-sphinx-8.1.0.dist-info/entry_points.txt,sha256=KU_c9jqXj7yyZylSz11XRIXG3gAZApQa0d5DmcfyA7M,188
-sphinx-8.1.0.dist-info/LICENSE.rst,sha256=uL2etL9JJaDLeIqs1Hm7ZNqo4AsoMO_3WiFzvc2zuu0,1476
-sphinx-8.1.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-sphinx-8.1.0.dist-info/METADATA,sha256=DAoDRISjJq4AQOacyEiNaSKtzkLlOOhOJ0UC5zdgCXo,6351
-sphinx-8.1.0.dist-info/RECORD,,
+sphinx-8.1.2.dist-info/entry_points.txt,sha256=KU_c9jqXj7yyZylSz11XRIXG3gAZApQa0d5DmcfyA7M,188
+sphinx-8.1.2.dist-info/LICENSE.rst,sha256=uL2etL9JJaDLeIqs1Hm7ZNqo4AsoMO_3WiFzvc2zuu0,1476
+sphinx-8.1.2.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+sphinx-8.1.2.dist-info/METADATA,sha256=6ugdNy7jnGR7NieWOrHSorAi9wvBaZwwwoZrl31OQfk,6407
+sphinx-8.1.2.dist-info/RECORD,,