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

sphinx/__init__.py

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

sphinx/config.py

@@ -51,30 +51,28 @@ class ConfigValue(NamedTuple):
     rebuild: _ConfigRebuild
 
 
-def is_serializable(obj: object, *, _recursive_guard: frozenset[int] = frozenset()) -> bool:
-    """Check if object is serializable or not."""
+def is_serializable(obj: object, *, _seen: frozenset[int] = frozenset()) -> bool:
+    """Check if an object is serializable or not."""
     if isinstance(obj, UNSERIALIZABLE_TYPES):
         return False
 
     # use id() to handle un-hashable objects
-    if id(obj) in _recursive_guard:
+    if id(obj) in _seen:
         return True
 
     if isinstance(obj, dict):
-        guard = _recursive_guard | {id(obj)}
-        for key, value in obj.items():
-            if (
-                not is_serializable(key, _recursive_guard=guard)
-                or not is_serializable(value, _recursive_guard=guard)
-            ):
-                return False
+        seen = _seen | {id(obj)}
+        return all(
+            is_serializable(key, _seen=seen) and is_serializable(value, _seen=seen)
+            for key, value in obj.items()
+        )
     elif isinstance(obj, (list, tuple, set, frozenset)):
-        guard = _recursive_guard | {id(obj)}
-        return all(is_serializable(item, _recursive_guard=guard) for item in obj)
+        seen = _seen | {id(obj)}
+        return all(is_serializable(item, _seen=seen) for item in obj)
 
     # if an issue occurs for a non-serializable type, pickle will complain
-    # since the object is likely coming from a third-party extension (we
-    # natively expect 'simple' types and not weird ones)
+    # since the object is likely coming from a third-party extension
+    # (we natively expect 'simple' types and not weird ones)
     return True
 
 
@@ -473,7 +471,8 @@ class Config:
                     # will always mark the config value as changed,
                     # and thus always invalidate the cache and perform a rebuild.
                     logger.warning(
-                        __('cannot cache unpickable configuration value: %r'),
+                        __('cannot cache unpickable configuration value: %r '
+                           '(because it contains a function, class, or module object)'),
                         name,
                         type='config',
                         subtype='cache',

sphinx/domains/c/__init__.py

@@ -44,6 +44,59 @@ if TYPE_CHECKING:
     from sphinx.environment import BuildEnvironment
     from sphinx.util.typing import ExtensionMetadata, OptionSpec
 
+# re-export objects for backwards compatibility
+# xref https://github.com/sphinx-doc/sphinx/issues/12295
+from sphinx.domains.c._ast import (  # NoQA: F401
+    ASTAlignofExpr,
+    ASTArray,
+    ASTAssignmentExpr,
+    ASTBase,
+    ASTBinOpExpr,
+    ASTBooleanLiteral,
+    ASTBracedInitList,
+    ASTCastExpr,
+    ASTCharLiteral,
+    ASTDeclarator,
+    ASTDeclaratorNameBitField,
+    ASTDeclaratorNameParam,
+    ASTDeclaratorParen,
+    ASTDeclaratorPtr,
+    ASTDeclSpecs,
+    ASTDeclSpecsSimple,
+    ASTEnum,
+    ASTEnumerator,
+    ASTExpression,
+    ASTFallbackExpr,
+    ASTFunctionParameter,
+    ASTIdExpression,
+    ASTInitializer,
+    ASTLiteral,
+    ASTMacro,
+    ASTMacroParameter,
+    ASTNumberLiteral,
+    ASTParameters,
+    ASTParenExpr,
+    ASTParenExprList,
+    ASTPostfixArray,
+    ASTPostfixCallExpr,
+    ASTPostfixDec,
+    ASTPostfixExpr,
+    ASTPostfixInc,
+    ASTPostfixMemberOfPointer,
+    ASTPostfixOp,
+    ASTSizeofExpr,
+    ASTSizeofType,
+    ASTStringLiteral,
+    ASTStruct,
+    ASTTrailingTypeSpec,
+    ASTTrailingTypeSpecFundamental,
+    ASTTrailingTypeSpecName,
+    ASTType,
+    ASTTypeWithInit,
+    ASTUnaryOpExpr,
+    ASTUnion,
+)
+
 logger = logging.getLogger(__name__)
 
 

sphinx/domains/cpp/__init__.py

@@ -48,6 +48,98 @@ if TYPE_CHECKING:
     from sphinx.environment import BuildEnvironment
     from sphinx.util.typing import ExtensionMetadata, OptionSpec
 
+# re-export objects for backwards compatibility
+# xref https://github.com/sphinx-doc/sphinx/issues/12295
+from sphinx.domains.cpp._ast import (  # NoQA: F401
+    ASTAlignofExpr,
+    ASTArray,
+    ASTAssignmentExpr,
+    ASTBase,
+    ASTBaseClass,
+    ASTBinOpExpr,
+    ASTBooleanLiteral,
+    ASTBracedInitList,
+    ASTCastExpr,
+    ASTCharLiteral,
+    ASTClass,
+    ASTCommaExpr,
+    ASTConcept,
+    ASTConditionalExpr,
+    ASTDeclarator,
+    ASTDeclaratorMemPtr,
+    ASTDeclaratorNameBitField,
+    ASTDeclaratorNameParamQual,
+    ASTDeclaratorParamPack,
+    ASTDeclaratorParen,
+    ASTDeclaratorPtr,
+    ASTDeclaratorRef,
+    ASTDeclSpecs,
+    ASTDeclSpecsSimple,
+    ASTDeleteExpr,
+    ASTEnum,
+    ASTEnumerator,
+    ASTExplicitCast,
+    ASTExplicitSpec,
+    ASTExpression,
+    ASTFallbackExpr,
+    ASTFoldExpr,
+    ASTFunctionParameter,
+    ASTIdExpression,
+    ASTInitializer,
+    ASTLiteral,
+    ASTNewExpr,
+    ASTNoexceptExpr,
+    ASTNoexceptSpec,
+    ASTNumberLiteral,
+    ASTOperator,
+    ASTOperatorBuildIn,
+    ASTOperatorLiteral,
+    ASTOperatorType,
+    ASTPackExpansionExpr,
+    ASTParametersQualifiers,
+    ASTParenExpr,
+    ASTParenExprList,
+    ASTPointerLiteral,
+    ASTPostfixArray,
+    ASTPostfixCallExpr,
+    ASTPostfixDec,
+    ASTPostfixExpr,
+    ASTPostfixInc,
+    ASTPostfixMember,
+    ASTPostfixMemberOfPointer,
+    ASTPostfixOp,
+    ASTRequiresClause,
+    ASTSizeofExpr,
+    ASTSizeofParamPack,
+    ASTSizeofType,
+    ASTStringLiteral,
+    ASTTemplateArgConstant,
+    ASTTemplateArgs,
+    ASTTemplateDeclarationPrefix,
+    ASTTemplateIntroduction,
+    ASTTemplateIntroductionParameter,
+    ASTTemplateKeyParamPackIdDefault,
+    ASTTemplateParam,
+    ASTTemplateParamConstrainedTypeWithInit,
+    ASTTemplateParamNonType,
+    ASTTemplateParams,
+    ASTTemplateParamTemplateType,
+    ASTTemplateParamType,
+    ASTThisLiteral,
+    ASTTrailingTypeSpec,
+    ASTTrailingTypeSpecDecltype,
+    ASTTrailingTypeSpecDecltypeAuto,
+    ASTTrailingTypeSpecFundamental,
+    ASTTrailingTypeSpecName,
+    ASTType,
+    ASTTypeId,
+    ASTTypeUsing,
+    ASTTypeWithInit,
+    ASTUnaryOpExpr,
+    ASTUnion,
+    ASTUserDefinedLiteral,
+)
+
 logger = logging.getLogger(__name__)
 
 

sphinx/domains/python/__init__.py

@@ -38,6 +38,10 @@ if TYPE_CHECKING:
 
 # re-export objects for backwards compatibility
 # xref https://github.com/sphinx-doc/sphinx/issues/12295
+from sphinx.domains.python._annotations import (  # NoQA: F401
+    _parse_arglist,  # for sphinx-immaterial
+    type_to_xref,
+)
 from sphinx.domains.python._object import (  # NoQA: F401
     PyField,
     PyGroupedField,

sphinx/theming.py

@@ -32,6 +32,7 @@ else:
     from importlib_metadata import entry_points
 
 if TYPE_CHECKING:
+    from collections.abc import Callable
     from typing import TypedDict
 
     from typing_extensions import Required
@@ -120,7 +121,17 @@ class Theme:
         elif section == 'options':
             value = self._options.get(name, default)
         else:
-            value = _NO_DEFAULT
+            # https://github.com/sphinx-doc/sphinx/issues/12305
+            # For backwards compatibility when attempting to read a value
+            # from an unsupported configuration section.
+            # xref: RemovedInSphinx80Warning
+            msg = __(
+                'Theme configuration sections other than [theme] and [options] '
+                'are not supported, returning the default value instead '
+                '(tried to get a value from %r)'
+            )
+            logger.info(msg % section)
+            value = default
         if value is _NO_DEFAULT:
             msg = __('setting %s.%s occurs in none of the searched theme configs') % (
                 section,
@@ -156,6 +167,7 @@ class HTMLThemeFactory:
     def __init__(self, app: Sphinx) -> None:
         self._app = app
         self._themes = app.registry.html_themes
+        self._entry_point_themes: dict[str, Callable[[], None]] = {}
         self._load_builtin_themes()
         if getattr(app.config, 'html_theme_path', None):
             self._load_additional_themes(app.config.html_theme_path)
@@ -183,8 +195,16 @@ class HTMLThemeFactory:
         for entry_point in entry_points(group='sphinx.html_themes'):
             if entry_point.name in self._themes:
                 continue  # don't overwrite loaded themes
-            self._app.registry.load_extension(self._app, entry_point.module)
-            _config_post_init(self._app, self._app.config)
+
+            def _load_theme_closure(
+                # bind variables in the function definition
+                app: Sphinx = self._app,
+                theme_module: str = entry_point.module,
+            ) -> None:
+                app.setup_extension(theme_module)
+                _config_post_init(app, app.config)
+
+            self._entry_point_themes[entry_point.name] = _load_theme_closure
 
     @staticmethod
     def _find_themes(theme_path: str) -> dict[str, str]:
@@ -217,10 +237,18 @@ class HTMLThemeFactory:
 
     def create(self, name: str) -> Theme:
         """Create an instance of theme."""
+        if name in self._entry_point_themes:
+            # Load a deferred theme from an entry point
+            entry_point_loader = self._entry_point_themes[name]
+            entry_point_loader()
         if name not in self._themes:
             raise ThemeError(__('no theme named %r found (missing theme.toml?)') % name)
 
-        themes, theme_dirs, tmp_dirs = _load_theme_with_ancestors(self._themes, name)
+        themes, theme_dirs, tmp_dirs = _load_theme_with_ancestors(
+            name,
+            self._themes,
+            self._entry_point_themes,
+        )
         return Theme(name, configs=themes, paths=theme_dirs, tmp_dirs=tmp_dirs)
 
 
@@ -235,7 +263,10 @@ def _is_archived_theme(filename: str, /) -> bool:
 
 
 def _load_theme_with_ancestors(
-    theme_paths: dict[str, str], name: str, /
+    name: str,
+    theme_paths: dict[str, str],
+    entry_point_themes: dict[str, Callable[[], None]],
+    /,
 ) -> tuple[dict[str, _ConfigFile], list[str], list[str]]:
     themes: dict[str, _ConfigFile] = {}
     theme_dirs: list[str] = []
@@ -253,6 +284,10 @@ def _load_theme_with_ancestors(
         if inherit in themes:
             msg = __('The %r theme has circular inheritance') % name
             raise ThemeError(msg)
+        if inherit in entry_point_themes and inherit not in theme_paths:
+            # Load a deferred theme from an entry point
+            entry_point_loader = entry_point_themes[inherit]
+            entry_point_loader()
         if inherit not in theme_paths:
             msg = __(
                 'The %r theme inherits from %r, which is not a loaded theme. '

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

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

{sphinx-7.3.5.dist-info → sphinx-7.3.7.dist-info}/RECORD

@@ -1,8 +1,8 @@
-sphinx/__init__.py,sha256=xwB-1xnP8xOaVq3e22IK3dZVTFoHaiQIRPMHjH8pevM,1694
+sphinx/__init__.py,sha256=7gy5LypY6hNPIaKbHRXv-Uk3PF6lqIRleU1xbmRaHZs,1694
 sphinx/__main__.py,sha256=wIifwXlZHdi4gtQmkJ6KF0BsflvD9o0Wd5nARTdJc8A,127
 sphinx/addnodes.py,sha256=EQTIi9Zta6DaNa-2WGE3l9AVjdp7WzwwrfwRnax8vXE,18707
 sphinx/application.py,sha256=ICEmiMaOt4m0Wl2GBeHHulbZNcDvEpXMyfVuzDxcEhk,56266
-sphinx/config.py,sha256=g7XAMEnrqq66hwPbzSxnooyeJl_UrEagFQ0SPxnXEtw,30085
+sphinx/config.py,sha256=qOPk7Mt41Wins29EO2Xb_X91gL4cxIRBCU-O0i00Gzw,30039
 sphinx/deprecation.py,sha256=ABIo1t4mSwCTT2uxpUKNcwQHb3X6qur_tziCWzIhqtE,2437
 sphinx/errors.py,sha256=mFyE7P1fmnVTeYtpP3wv8oXrKyTw1H0WcE46VypUPd0,3412
 sphinx/events.py,sha256=3GE0v6gIu81Llbed-6zBPDy9G1a-tY9Z1ujUIGBBN5M,4351
@@ -16,7 +16,7 @@ sphinx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sphinx/pygments_styles.py,sha256=0RJn6WC7rPnQu7BDqrqb0gkJcb3elRfizGVBW9bcmRE,2861
 sphinx/registry.py,sha256=LCWv2mDKNiN6IaE5tgUeWzmff9SFN7UWYwEN3QxbK4Q,22593
 sphinx/roles.py,sha256=8f9AJ8gUuOFrNzdgX6yhdE-Wc8ZeufoieMP4oL5lCAU,16964
-sphinx/theming.py,sha256=k71Gp6K9OrV-waG-dF3ZwtKJ9PnXCb-Do_teQUO_fvQ,18864
+sphinx/theming.py,sha256=MhnxVHWE8CpP9fbmp7CI1UBBJhzamfJmif501M82ozw,20308
 sphinx/versioning.py,sha256=Kro82eLQvxD8RQShAipw_1GcwivuOrOO1SsDIigGWz0,5942
 sphinx/builders/__init__.py,sha256=E9Z1LeE_3lCq0vPs1Po2xliMkXF0awcRiK87C_9ZVgw,26851
 sphinx/builders/_epub_base.py,sha256=gtXo-PcmxLZs7t4VrETy5Ek1rOA5Uk35YNEyUtMvB24,29021
@@ -55,17 +55,17 @@ sphinx/domains/index.py,sha256=3eHbatgPlpfeEbJtqQ6HfBQlEFSem9rYG8fdMUExypU,4266
 sphinx/domains/javascript.py,sha256=vGuLe4mtbVzwXyWfHuDQIyFpACKo_2TXTFUaUCw6ebU,19444
 sphinx/domains/math.py,sha256=56YFKQ0o5o2ep9EZ8IobFIsgHpKrOYonSsqjGs_b6EE,5655
 sphinx/domains/rst.py,sha256=8nsCjM2GNScWq56u0MC1GaZxlSWBUfXLl_qCYVYdVFU,10696
-sphinx/domains/c/__init__.py,sha256=kJKWgiC_6tb-Ueomooj4Up78k_ez7MtVxpqBhFt-E30,31467
+sphinx/domains/c/__init__.py,sha256=SmpOFHMVw65CN3jDuS7WLOoNe0wKsazM6P_4hEqlZAg,32620
 sphinx/domains/c/_ast.py,sha256=C7UD3KNf-LZjOPzZ04zfdbm5G0wy-4wGIpLPPdZnSuY,52724
 sphinx/domains/c/_ids.py,sha256=R_6xOt4CSGmDxkXwJ5MElKhLLjkZSJdZdvwIr0VvEoM,2220
 sphinx/domains/c/_parser.py,sha256=1jTwk2nHwZqDq5PCd2bxhmA8ElO9WBwHGCniaynH4Zs,41261
 sphinx/domains/c/_symbol.py,sha256=dmmsF1tNcDGw_rOMRywjqc3DkKxWWFvKRr4Eel15j5A,28256
-sphinx/domains/cpp/__init__.py,sha256=hlNSpvBCtW2DR98vFq8cRs86X5U1LQmy_hdHzOupY8U,45018
+sphinx/domains/cpp/__init__.py,sha256=y9QfCqlleF9Q5K_HSzafjgzqUSsX-EEpX0IxgGJHkdo,47157
 sphinx/domains/cpp/_ast.py,sha256=P2yAf7gCCtUSZrMdDn6m9dd6-MhhAcvRFQtDGwqO23w,137953
 sphinx/domains/cpp/_ids.py,sha256=-h42RrmFnuq4AyZ0EVHtAk_H_9Umrca24Tu-w73TKCw,18028
 sphinx/domains/cpp/_parser.py,sha256=EaKoUzpUgZnAFKZYfOBl_-Iw8z2LdYxfZtdWglpSE3Q,88250
 sphinx/domains/cpp/_symbol.py,sha256=pyjUC0tvGs_3j8Qlafw5u9EUAQyPqj5ukbbE8LUkEUo,48775
-sphinx/domains/python/__init__.py,sha256=j51-9Pm7H0lrzQP9fO81rOpIce2A2VUdjv49kgju-iQ,33958
+sphinx/domains/python/__init__.py,sha256=jP8eICP3-1SQHxDm55061og_jIEEqg7S0A2q8VsgQi0,34086
 sphinx/domains/python/_annotations.py,sha256=bLay4nHo1L7KxfX2exE2ttTLqwOnMBDVEg7r6v_YeSY,22302
 sphinx/domains/python/_object.py,sha256=Kds5Z-5bNNh2dIgStb6bEu0l9y-bC8Rga4jz1lzwGwU,17000
 sphinx/domains/std/__init__.py,sha256=rQ4gJSs74w7PQDjJ4Qu2vBcr0_kpXyUXA897BOjlEQc,46277
@@ -574,8 +574,8 @@ sphinx/writers/manpage.py,sha256=nLPgs3A5mVouhjiY2Olfoxh7PTFUZc1stHhThGDRSM4,161
 sphinx/writers/texinfo.py,sha256=YaVcaaK533HWd14FJkBJwkZZNL5Yh6rv2rcFrkhR4SU,53220
 sphinx/writers/text.py,sha256=HEiYXsWXO9QVOazg2V3D0ehGTnK38dAtYP9v0rst684,42964
 sphinx/writers/xml.py,sha256=NyDl82hCFSRiHrCZV6vBfn4AsAyXH6khtSJEfhOX8a0,1502
-sphinx-7.3.5.dist-info/entry_points.txt,sha256=KU_c9jqXj7yyZylSz11XRIXG3gAZApQa0d5DmcfyA7M,188
-sphinx-7.3.5.dist-info/LICENSE.rst,sha256=HdZPUFcmQaLySBc9fKvRC5aOUNkxL9Gz5py0p6XGDk4,3135
-sphinx-7.3.5.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-sphinx-7.3.5.dist-info/METADATA,sha256=Rf0VlooekrRJUqECzZzuf5EDmzbNI7KQQfiLXmhGr3U,6021
-sphinx-7.3.5.dist-info/RECORD,,
+sphinx-7.3.7.dist-info/entry_points.txt,sha256=KU_c9jqXj7yyZylSz11XRIXG3gAZApQa0d5DmcfyA7M,188
+sphinx-7.3.7.dist-info/LICENSE.rst,sha256=HdZPUFcmQaLySBc9fKvRC5aOUNkxL9Gz5py0p6XGDk4,3135
+sphinx-7.3.7.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+sphinx-7.3.7.dist-info/METADATA,sha256=5b_W8GYzkdC-boJ-961YHOC-uQB_R88uBnhgso9tE6A,6021
+sphinx-7.3.7.dist-info/RECORD,,