Sphinx 8.2.1__py3-none-any.whl → 8.3.0__py3-none-any.whl

sphinx/__init__.py

@@ -1,24 +1,25 @@
 """The Sphinx documentation toolchain."""
 
-from __future__ import annotations
-
-__version__ = '8.2.1'
-__display_version__ = __version__  # used for command line version
-
 # Keep this file executable as-is in Python 3!
 # (Otherwise getting the version out of it when packaging is impossible.)
 
-import os
+from __future__ import annotations
+
 import warnings
 
-from sphinx.util._pathlib import _StrPath
+# work around flit error in parsing annotated assignments
+try:
+    from sphinx.util._pathlib import _StrPath
+except ImportError:
+    from pathlib import Path as _StrPath  # type: ignore[assignment]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Final
 
-# by default, all DeprecationWarning under sphinx package will be emit.
-# Users can avoid this by using environment variable: PYTHONWARNINGS=
-if 'PYTHONWARNINGS' not in os.environ:
-    from sphinx.deprecation import RemovedInNextVersionWarning
+__version__: Final = '8.3.0'
+__display_version__: Final = __version__  # used for command line version
 
-    warnings.filterwarnings('default', category=RemovedInNextVersionWarning)
 warnings.filterwarnings(
     'ignore',
     'The frontend.Option class .*',
@@ -34,9 +35,9 @@ warnings.filterwarnings(
 #:
 #: .. versionadded:: 1.2
 #:    Before version 1.2, check the string ``sphinx.__version__``.
-version_info = (8, 2, 1, 'final', 0)
+version_info: Final = (8, 2, 2, 'final', 0)
 
-package_dir = _StrPath(__file__).resolve().parent
+package_dir: Final = _StrPath(__file__).resolve().parent
 
 _in_development = False
 if _in_development:
@@ -45,14 +46,14 @@ if _in_development:
 
     try:
         if ret := subprocess.run(
-            ['git', 'rev-parse', '--short', 'HEAD'],  # NoQA: S607
-            cwd=package_dir,
+            ('git', 'rev-parse', '--short', 'HEAD'),
             capture_output=True,
             check=False,
-            encoding='ascii',
+            cwd=package_dir,
+            encoding='utf-8',
             errors='surrogateescape',
         ).stdout:
-            __display_version__ += '+/' + ret.strip()
+            __display_version__ += f'+/{ret.strip()}'  # type: ignore[misc]
         del ret
     finally:
         del subprocess

sphinx/application.py

@@ -1507,6 +1507,7 @@ class Sphinx:
         elif loading_method == 'defer':
             kwargs['defer'] = 'defer'
 
+        filename = filename or ''
         self.registry.add_js_file(filename, priority=priority, **kwargs)
         with contextlib.suppress(AttributeError):
             self.builder.add_js_file(  # type: ignore[attr-defined]

sphinx/deprecation.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import os
 import warnings
 
 
@@ -16,6 +17,12 @@ class RemovedInSphinx10Warning(PendingDeprecationWarning):
 RemovedInNextVersionWarning = RemovedInSphinx90Warning
 
 
+# By default, all Sphinx deprecation warnings will be emitted.
+# To avoid this, set the environment variable: PYTHONWARNINGS=
+if 'PYTHONWARNINGS' not in os.environ:
+    warnings.filterwarnings('default', category=RemovedInNextVersionWarning)
+
+
 def _deprecation_warning(
     module: str,
     attribute: str,

sphinx/ext/apidoc/_extension.py

@@ -217,7 +217,6 @@ def _parse_module_options(
         dest_dir=dest_path,
         module_path=module_path,
         exclude_pattern=exclude_patterns,
-        automodule_options=automodule_options,
         max_depth=max_depth,
         quiet=True,
         follow_links=bool_options['follow_links'],
@@ -226,6 +225,8 @@ def _parse_module_options(
         no_headings=bool_options['no_headings'],
         module_first=bool_options['module_first'],
         implicit_namespaces=bool_options['implicit_namespaces'],
+        automodule_options=automodule_options,
+        header=module_path.name,
     )
 
 

sphinx/locale/__init__.py

@@ -8,11 +8,15 @@ from gettext import NullTranslations, translation
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+from sphinx import package_dir
+
 if TYPE_CHECKING:
     import os
     from collections.abc import Callable, Iterable
     from typing import Any
 
+_LOCALE_DIR = Path(package_dir, 'locale')
+
 
 class _TranslationProxy:
     """The proxy implementation attempts to be as complete as possible, so that
@@ -140,9 +144,6 @@ def init(
     return translator, has_translation
 
 
-_LOCALE_DIR = Path(__file__).resolve().parent
-
-
 def init_console(
     locale_dir: str | os.PathLike[str] | None = None,
     catalog: str = 'sphinx',

sphinx/search/zh.py

@@ -4,19 +4,33 @@ from __future__ import annotations
 
 import re
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 import snowballstemmer
 
 from sphinx.search import SearchLanguage
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
 try:
     import jieba  # type: ignore[import-not-found]
-
-    JIEBA = True
-    JIEBA_DEFAULT_DICT = Path(jieba.__file__).parent / jieba.DEFAULT_DICT_NAME
+    from jieba import cut_for_search
+    from jieba import load_userdict as jieba_load_userdict
 except ImportError:
-    JIEBA = False
-    JIEBA_DEFAULT_DICT = Path()
+    JIEBA_DEFAULT_DICT = ''
+
+    def jieba_load_userdict(f: str) -> None:
+        pass
+
+    def cut_for_search(sentence: str, HMM: bool = True) -> Iterator[str]:
+        yield from ()
+
+else:
+    JIEBA_DEFAULT_DICT = (
+        Path(jieba.__file__, '..', jieba.DEFAULT_DICT_NAME).resolve().as_posix()
+    )
+    del jieba
 
 english_stopwords = {
     'a', 'and', 'are', 'as', 'at',
@@ -231,18 +245,14 @@ class SearchChinese(SearchLanguage):
         self.latin_terms: set[str] = set()
 
     def init(self, options: dict[str, str]) -> None:
-        if JIEBA:
-            dict_path = options.get('dict', JIEBA_DEFAULT_DICT)
-            if dict_path and Path(dict_path).is_file():
-                jieba.load_userdict(dict_path)
+        dict_path = options.get('dict', JIEBA_DEFAULT_DICT)
+        if dict_path and Path(dict_path).is_file():
+            jieba_load_userdict(str(dict_path))
 
         self.stemmer = snowballstemmer.stemmer('english')
 
     def split(self, input: str) -> list[str]:
-        if JIEBA:
-            chinese: list[str] = list(jieba.cut_for_search(input))
-        else:
-            chinese = []
+        chinese: list[str] = list(cut_for_search(input))
 
         latin1 = [term.strip() for term in self.latin1_letters.findall(input)]
         self.latin_terms.update(latin1)

sphinx/util/__init__.py

@@ -62,6 +62,13 @@ def __getattr__(name: str) -> Any:
     obj: Callable[..., Any]
     mod: ModuleType
 
+    if name == 'console':
+        # Explicit temporary workaround for nbsphinx implicit imports.
+        # https://github.com/sphinx-doc/sphinx/issues/13352
+        import sphinx.util.console as mod
+
+        return mod
+
     # RemovedInSphinx90Warning
     if name == 'split_index_msg':
         from sphinx.util.index_entries import split_index_msg as obj

{sphinx-8.2.1.dist-info → sphinx-8.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Sphinx
-Version: 8.2.1
+Version: 8.3.0
 Summary: Python documentation generator
 Author-email: Adam Turner <aa-turner@users.noreply.github.com>, Georg Brandl <georg@python.org>
 Requires-Python: >=3.11
@@ -69,7 +69,7 @@ Requires-Dist: roman-numerals-py>=1.0.0
 Requires-Dist: packaging>=23.0
 Requires-Dist: colorama>=0.4.6; sys_platform == 'win32'
 Requires-Dist: sphinxcontrib-websupport ; extra == "docs"
-Requires-Dist: ruff==0.9.7 ; extra == "lint"
+Requires-Dist: ruff==0.9.9 ; extra == "lint"
 Requires-Dist: mypy==1.15.0 ; extra == "lint"
 Requires-Dist: sphinx-lint>=0.9 ; extra == "lint"
 Requires-Dist: types-colorama==0.4.15.20240311 ; extra == "lint"
@@ -79,7 +79,7 @@ Requires-Dist: types-Pillow==10.2.0.20240822 ; extra == "lint"
 Requires-Dist: types-Pygments==2.19.0.20250219 ; extra == "lint"
 Requires-Dist: types-requests==2.32.0.20241016 ; extra == "lint"
 Requires-Dist: types-urllib3==1.26.25.14 ; extra == "lint"
-Requires-Dist: pyright==1.1.394 ; extra == "lint"
+Requires-Dist: pyright==1.1.395 ; extra == "lint"
 Requires-Dist: pytest>=8.0 ; extra == "lint"
 Requires-Dist: pypi-attestations==0.0.21 ; extra == "lint"
 Requires-Dist: betterproto==2.0.0b6 ; extra == "lint"

{sphinx-8.2.1.dist-info → sphinx-8.3.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
-sphinx/__init__.py,sha256=sTmq1a5LGaVMSkcGYeVmBgSPCqQPu0TgPVowXHaWFCY,1789
+sphinx/__init__.py,sha256=qwy6FBnG2snAGt4jMEbXpJ6nXgR5f8nUFJxbT00Z0Ys,1719
 sphinx/__main__.py,sha256=PYSg7M8rY5VgULh3SJEaYMWsB1YFJw7f40b50yW8NEE,163
 sphinx/addnodes.py,sha256=QFvrCg9bGgH_zsGFVeUzGWcvqIQXtC-b7jXUYZEJRsk,18502
-sphinx/application.py,sha256=FgR54sWE9-hH548ZUbe3x0v_NlRRUAZ4JjorhwDF8eg,66893
+sphinx/application.py,sha256=gjI_Sv3JARUUaGSPvaJlJ5TM8_tckDVnh0dBkSxZcaI,66927
 sphinx/config.py,sha256=7Raa_GVF6S0uZWDbYL6VkG9N8OlKHM7g5s5CPgyHNtU,34297
-sphinx/deprecation.py,sha256=U4BIydQiXjU3seaMOORp6bVeVleg-3xcAl_iU7bu2eA,2521
+sphinx/deprecation.py,sha256=rgOkaj4FTR1ZLdrxAxh_DyrYWyXGFlCmUXclkvBNlN4,2775
 sphinx/errors.py,sha256=lk9KPV3Grp64NwoU81JhK0rr1ybBS_d2iaXyhosVrSg,3413
 sphinx/events.py,sha256=NXjTchmTJN8VKGcWo47EJmopcIboEBXS5MT6namRpL0,12120
 sphinx/extension.py,sha256=qnA_a5SlIz5-3RcHAJ1tpLnBeznVEQzkAPh7WIEAAxU,3192
@@ -106,7 +106,7 @@ sphinx/ext/viewcode.py,sha256=GSfhXGX2EBoVjAG0SDv7kkUSktKUwRRBc-xPmvpDi-w,15109
 sphinx/ext/apidoc/__init__.py,sha256=rvtSje1ayQSBwbVYJwkSPZV_NrdZiqdfvgy_dYOfAhI,2227
 sphinx/ext/apidoc/__main__.py,sha256=-kCJWW_BL2zpvylBkK3U_XqVBNKEAETeghxR_UHsJvw,182
 sphinx/ext/apidoc/_cli.py,sha256=MeApBSdy14-cXJiuEJeY1E366xFFfqSuvrYNOatcUHo,10182
-sphinx/ext/apidoc/_extension.py,sha256=OjrJFA9HwEJrK392IayeGa4tnS5olRD_5FO58vxlpdw,7505
+sphinx/ext/apidoc/_extension.py,sha256=Ng-L5I0o7C7kivph13IIndEqHO3PkhxTVozxp5drg8U,7538
 sphinx/ext/apidoc/_generate.py,sha256=EAhpB2PUwsjdPNV6UN8KCOXbgWwaeOdmV577amk29iU,11909
 sphinx/ext/apidoc/_shared.py,sha256=wer5szQBKbF1be0NBW_DW2ugMb9zWZ1MvQAQE-DYbqc,2908
 sphinx/ext/autodoc/__init__.py,sha256=gpklYg_A3gPPqyargGVHf_wWAyAJJoK4x0_5PNm3zv4,121569
@@ -129,7 +129,7 @@ sphinx/ext/intersphinx/_resolve.py,sha256=ym1WIZDG239cPuSqkOfvtyNnQFqVUW8e8YnOk8
 sphinx/ext/intersphinx/_shared.py,sha256=0xyJvKFopwAPrtxibmWaMv7Zqpby8bdrrtQxzZWAmYk,5490
 sphinx/ext/napoleon/__init__.py,sha256=UHmmL03gExDg14G9O1lV9lLaEmFD7SW8LkQGBW79btI,18649
 sphinx/ext/napoleon/docstring.py,sha256=VAWXHZDSctCco8alEsPvaAt_y2apvS3g3qVuG7QjTmE,50736
-sphinx/locale/__init__.py,sha256=80U_6HxueS089sipT-W0pTuKyDAkfVy3xqyHO2BrK_U,7299
+sphinx/locale/__init__.py,sha256=1k1bE9OQ0bfT3bHn3KQ_xmB6Kv_3OrbBDKb3h_L6-Go,7326
 sphinx/locale/sphinx.pot,sha256=1Q8cDBljOc5019N_ALi09YIz1N3qqcCZhcjmtxpPvwk,91003
 sphinx/locale/.tx/config,sha256=WhhxMTRN6Jtvv0v4eQdX003u8JDsCtT9_Ln2n4X8eBM,165
 sphinx/locale/ar/LC_MESSAGES/sphinx.js,sha256=_HHzyE81QrF_0oZdAAN2CDGCBtacPWMVMRKPG0vlmWQ,3585
@@ -356,7 +356,7 @@ sphinx/search/ro.py,sha256=hPXwj-tUOp-MDPV4SfHMFAVFQJ96X7O0u3v6p5Ghbs0,537
 sphinx/search/ru.py,sha256=PZWcdpHAIUpBSuqSAyLhlPKrhgFOLn5gC6tlyR3gERI,7891
 sphinx/search/sv.py,sha256=MUTtDlXnbeAS26i79u-6ftqARTH0mddUJYRCg48Bdxc,3422
 sphinx/search/tr.py,sha256=Zc8yCcfrolX2XKGnKmlC046FZs3wG-GBRRFFC6i0hw4,531
-sphinx/search/zh.py,sha256=-VaddW4SNBRoTDdtAZrnkvFkDwG6jMSGtC-NmfuMOnE,6479
+sphinx/search/zh.py,sha256=VS04e0WQ_Kaqg9C8xQi1V-WuGt4uIFk5cEqaWYUc3Oo,6748
 sphinx/search/minified-js/base-stemmer.js,sha256=A_tSOI9F30VjUWOoXxSW9tuyeYAw4iemUS7rGCKROOE,3594
 sphinx/search/minified-js/danish-stemmer.js,sha256=jZxzX8AJMWwmA55-XE9x0MA8jeWp4VslFGe1y29mEQE,3123
 sphinx/search/minified-js/dutch-stemmer.js,sha256=UEIU4hOLfXsjl0Nklym2n04Wnik9Dpj0XU2O2CFzeJ4,5529
@@ -553,7 +553,7 @@ sphinx/transforms/references.py,sha256=6z0wqnfn8D38KKInB_xv_6oFyEpfhU63ew1dhlh-R
 sphinx/transforms/post_transforms/__init__.py,sha256=x55Pz3AvOazP8njxhQxgrJ3mciBd1qYCIMDp2ZWXCiM,14335
 sphinx/transforms/post_transforms/code.py,sha256=oHZPcq-IEHP8TRCIebJXYOV-R4sONtU4YVBSqwv-x3Q,4509
 sphinx/transforms/post_transforms/images.py,sha256=gjiCYFdj25SRvb3mJR7zh6DAQZXKgpKintz7KWf7MEc,10764
-sphinx/util/__init__.py,sha256=ZfsbhGogFmQ3pk2GmCAK1GOhGk7Z1ir9ytxMHj6rM7E,4105
+sphinx/util/__init__.py,sha256=azC1YSplYSMGdaql21qMsCQFJ3gJPau5hRQUcK4XwPc,4325
 sphinx/util/_files.py,sha256=oA22fogqLB8_a-Apc519-RdI08WkfI0zfo8vvpY61l4,3152
 sphinx/util/_importer.py,sha256=oGo_Yt-axe6M63x9akvf1UNw1tMMx1nU58TW8_MBcfQ,941
 sphinx/util/_inventory_file_reader.py,sha256=5XtzK-FBI5lQjMmYx4tg4E_T0Q9CMuVqu5hlW-R8JCk,2027
@@ -599,8 +599,8 @@ sphinx/writers/manpage.py,sha256=rwur1uSNhRsPlb4U1tXwtV3gqz-W1RD-yIw29Qmjxo4,155
 sphinx/writers/texinfo.py,sha256=WOMdKuYov6lt9PH34gsO1UbdYE48W3GdU0sZ7tw73pE,52791
 sphinx/writers/text.py,sha256=8FSF2vj0NaJHCMmHK3Rz6H8-iSMBpkyVT2VOT5-mLXA,43916
 sphinx/writers/xml.py,sha256=qaxAMR7htHmo3tQgqi9_8DD_B0HJEvz9hZH1iJwZkdk,1730
-sphinx-8.2.1.dist-info/entry_points.txt,sha256=KU_c9jqXj7yyZylSz11XRIXG3gAZApQa0d5DmcfyA7M,188
-sphinx-8.2.1.dist-info/licenses/LICENSE.rst,sha256=ZMlpGbuvOhO6oPEOQYzB_Ih2jOG5wH9be_SfD7I9sQY,1476
-sphinx-8.2.1.dist-info/WHEEL,sha256=_2ozNFCLWc93bK4WKHCO-eDUENDlo-dgc9cU3qokYO4,82
-sphinx-8.2.1.dist-info/METADATA,sha256=iiOR-gWz5zRVOAFuFRr_pc0tKEk_--n0mlrWpb14Wo8,7013
-sphinx-8.2.1.dist-info/RECORD,,
+sphinx-8.3.0.dist-info/entry_points.txt,sha256=KU_c9jqXj7yyZylSz11XRIXG3gAZApQa0d5DmcfyA7M,188
+sphinx-8.3.0.dist-info/licenses/LICENSE.rst,sha256=ZMlpGbuvOhO6oPEOQYzB_Ih2jOG5wH9be_SfD7I9sQY,1476
+sphinx-8.3.0.dist-info/WHEEL,sha256=_2ozNFCLWc93bK4WKHCO-eDUENDlo-dgc9cU3qokYO4,82
+sphinx-8.3.0.dist-info/METADATA,sha256=ZU6pBXhYE7oudK_qhD9QQB_vFX8AKm38JcEWUS1xPN4,7013
+sphinx-8.3.0.dist-info/RECORD,,