Sphinx 8.2.1__tar.gz → 8.2.2__tar.gz

{sphinx-8.2.1 → sphinx-8.2.2}/AUTHORS.rst

@@ -45,7 +45,7 @@ Contributors
 * Daniel Eades -- improved static typing
 * Daniel Hahler -- testing and CI improvements
 * Daniel Pizetta -- inheritance diagram improvements
-* Dave Hoese -- ``sphinx.ext.viewcode`` bug fix
+* Dave Hoese -- ``sphinx.ext.viewcode`` and ``sphinx.ext.apidoc`` bug fixes
 * Dave Kuhlman -- original LaTeX writer
 * Dimitri Papadopoulos Orfanos -- linting and spelling
 * Dmitry Shachnev -- modernisation and reproducibility

sphinx-8.2.2/CHANGES.rst

@@ -0,0 +1,20 @@
+Release 8.3.0 (in development)
+==============================
+
+Dependencies
+------------
+
+Incompatible changes
+--------------------
+
+Deprecated
+----------
+
+Features added
+--------------
+
+Bugs fixed
+----------
+
+Testing
+-------

{sphinx-8.2.1 → sphinx-8.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Sphinx
-Version: 8.2.1
+Version: 8.2.2
 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/CHANGES.rst → sphinx-8.2.2/doc/changes/8.2.rst

@@ -1,3 +1,20 @@
+==========
+Sphinx 8.2
+==========
+
+
+Release 8.2.2 (released Mar 01, 2025)
+=====================================
+
+Bugs fixed
+----------
+
+* #13392: Fix argument type for ``jieba.load_userdict()``.
+* Add workaround for ``nbsphinx`` implicit imports.
+* #13402: Ensure inline ``<script/>`` tags are written exactly once.
+* #13391: apidoc: Fix TOC file not having a title.
+  Patch by Dave Hoese.
+
 Release 8.2.1 (released Feb 21, 2025)
 =====================================
 
@@ -13,7 +30,8 @@ Bugs fixed
   Patch by Dave Hoese.
 * #13382: Napoleon: Use the right valid types for configuration values.
   Patch by Adam Turner.
-* 13376: Fix copying assets from a relative :confval:`html_static_path` entry.
+* #13376: Fix copying assets from relative :confval:`html_static_path` and
+  :confval:`html_extra_path` entries.
   Patch by Adam Turner.
 
 Release 8.2.0 (released Feb 18, 2025)

{sphinx-8.2.1 → sphinx-8.2.2}/doc/changes/index.rst

@@ -24,6 +24,7 @@ Prior releases
 .. toctree::
    :maxdepth: 2
 
+   8.2
    8.1
    8.0
    7.4

{sphinx-8.2.1 → sphinx-8.2.2}/pyproject.toml

@@ -92,7 +92,7 @@ docs = [
     "sphinxcontrib-websupport",
 ]
 lint = [
-    "ruff==0.9.7",
+    "ruff==0.9.9",
     "mypy==1.15.0",
     "sphinx-lint>=0.9",
     "types-colorama==0.4.15.20240311",
@@ -102,7 +102,7 @@ lint = [
     "types-Pygments==2.19.0.20250219",
     "types-requests==2.32.0.20241016",  # align with requests
     "types-urllib3==1.26.25.14",
-    "pyright==1.1.394",
+    "pyright==1.1.395",
     "pytest>=8.0",
     "pypi-attestations==0.0.21",
     "betterproto==2.0.0b6",

{sphinx-8.2.1 → sphinx-8.2.2}/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.2.2'
+__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-8.2.1 → sphinx-8.2.2}/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-8.2.1 → sphinx-8.2.2}/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-8.2.1 → sphinx-8.2.2}/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-8.2.1 → sphinx-8.2.2}/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-8.2.1 → sphinx-8.2.2}/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-8.2.1 → sphinx-8.2.2}/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 → sphinx-8.2.2}/tests/test_extensions/test_ext_apidoc.py

@@ -782,13 +782,14 @@ def test_sphinx_extension(app: SphinxTestApp) -> None:
     app.build()
     assert app.warning.getvalue() == ''
 
-    assert set((app.srcdir / 'generated').iterdir()) == {
-        app.srcdir / 'generated' / 'modules.rst',
-        app.srcdir / 'generated' / 'my_package.rst',
-    }
-    assert 'show-inheritance' not in (
-        app.srcdir / 'generated' / 'my_package.rst'
-    ).read_text(encoding='utf8')
+    toc_file = app.srcdir / 'generated' / 'modules.rst'
+    pkg_file = app.srcdir / 'generated' / 'my_package.rst'
+    assert set((app.srcdir / 'generated').iterdir()) == {toc_file, pkg_file}
+    modules_content = toc_file.read_text(encoding='utf8')
+    assert modules_content == (
+        'src\n===\n\n.. toctree::\n   :maxdepth: 3\n\n   my_package\n'
+    )
+    assert 'show-inheritance' not in pkg_file.read_text(encoding='utf8')
     assert (app.outdir / 'generated' / 'my_package.html').is_file()
 
     # test a re-build

{sphinx-8.2.1 → sphinx-8.2.2}/utils/babel_runner.py

@@ -86,9 +86,9 @@ def run_extract() -> None:
     with open('sphinx/__init__.py', encoding='utf-8') as f:
         lines = f.readlines()
     for line in lines:
-        if line.startswith('__version__ = '):
+        if line.startswith('__version__: Final = '):
             # remove prefix; strip whitespace; remove quotation marks
-            sphinx_version = line[14:].strip()[1:-1]
+            sphinx_version = line[21:].strip()[1:-1]
             break
 
     catalogue = Catalog(project='Sphinx', version=sphinx_version, charset='utf-8')

{sphinx-8.2.1 → sphinx-8.2.2}/utils/bump_version.py

@@ -94,11 +94,11 @@ def bump_version(
         lines = f.read().splitlines(keepends=True)
 
     for i, line in enumerate(lines):
-        if line.startswith('__version__ = '):
-            lines[i] = f"__version__ = '{version}'\n"
+        if line.startswith('__version__: Final = '):
+            lines[i] = f"__version__: Final = '{version}'\n"
             continue
-        if line.startswith('version_info = '):
-            lines[i] = f'version_info = {version_info.release_tuple}\n'
+        if line.startswith('version_info: Final = '):
+            lines[i] = f'version_info: Final = {version_info.release_tuple}\n'
             continue
         if line.startswith('_in_development = '):
             lines[i] = f'_in_development = {in_develop}\n'