Sphinx 8.1.1__tar.gz → 8.1.3__tar.gz

{sphinx-8.1.1 → sphinx-8.1.3}/CHANGES.rst

@@ -1,3 +1,25 @@
+Release 8.1.3 (released Oct 13, 2024)
+=====================================
+
+Bugs fixed
+----------
+
+* #13013: Restore support for :func:`!cut_lines` with no object type.
+  Patch by Adam Turner.
+
+Release 8.1.2 (released Oct 12, 2024)
+=====================================
+
+Bugs fixed
+----------
+
+* #13012: Expose :exc:`sphinx.errors.ExtensionError` in ``sphinx.util``
+  for backwards compatibility.
+  This will be removed in Sphinx 9, as exposing the exception
+  in ``sphinx.util`` was never intentional.
+  :exc:`!ExtensionError` has been part of ``sphinx.errors`` since Sphinx 0.9.
+  Patch by Adam Turner.
+
 Release 8.1.1 (released Oct 11, 2024)
 =====================================
 
@@ -11,7 +33,6 @@ Bugs fixed
   ``fontawesome`` or ``fontawesome5`` packages are not installed.
   Patch by Jean-François B.
 
-
 Release 8.1.0 (released Oct 10, 2024)
 =====================================
 

{sphinx-8.1.1 → sphinx-8.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Sphinx
-Version: 8.1.1
+Version: 8.1.3
 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.1 → sphinx-8.1.3}/doc/development/html_themes/templating.rst

@@ -308,20 +308,13 @@ in the future.
    .. versionadded:: 4.0
 
 .. data:: master_doc
+          root_doc
 
-   Same as :data:`root_doc`.
+   The value of :confval:`master_doc` or :confval:`root_doc` (aliases),
+   for usage with :func:`pathto`.
 
-   .. versionchanged:: 4.0
-
-      Renamed to ``root_doc``.
-
-.. data:: root_doc
-
-   The value of :confval:`root_doc`, for usage with :func:`pathto`.
-
-   .. versionchanged:: 4.0
-
-      Renamed from ``master_doc``.
+   .. versionadded:: 4.0
+      The :data:`!root_doc` template variable.
 
 .. data:: pagename
 

{sphinx-8.1.1 → sphinx-8.1.3}/doc/development/tutorials/examples/autodoc_intenum.py

@@ -35,16 +35,15 @@ class IntEnumDocumenter(ClassDocumenter):
     def add_content(
         self,
         more_content: StringList | None,
-        no_docstring: bool = False,
     ) -> None:
-        super().add_content(more_content, no_docstring)
+        super().add_content(more_content)
 
         source_name = self.get_sourcename()
         enum_object: IntEnum = self.object
         use_hex = self.options.hex
         self.add_line('', source_name)
 
-        for the_member_name, enum_member in enum_object.__members__.items():
+        for the_member_name, enum_member in enum_object.__members__.items():  # type: ignore[attr-defined]
             the_member_value = enum_member.value
             if use_hex:
                 the_member_value = hex(the_member_value)

{sphinx-8.1.1 → sphinx-8.1.3}/doc/extdev/builderapi.rst

@@ -16,7 +16,7 @@ Builder API
 
    .. rubric:: Overridable Attributes
 
-   These attributes should be set on builder sub-classes:
+   These class attributes should be set on builder sub-classes:
 
    .. autoattribute:: name
    .. autoattribute:: format
@@ -29,8 +29,7 @@ Builder API
 
    .. rubric:: Core Methods
 
-   These methods are predefined and should generally not be overridden,
-   since they form the core of the build process:
+   These methods define the core build workflow and must not be overridden:
 
    .. automethod:: build_all
    .. automethod:: build_specific
@@ -73,11 +72,12 @@ Builder API
    Builder sub-classes can set these attributes to support built-in extensions:
 
    .. attribute:: supported_linkcode
+      :type: str
 
       By default, the :mod:`linkcode <sphinx.ext.linkcode>` extension will
       only inject references for an ``html`` builder.
-      The ``supported_linkcode`` attribute can be defined in a non-HTML builder
-      to support managing references generated by linkcode.
+      The ``supported_linkcode`` class attribute can be defined in a
+      non-HTML builder to support managing references generated by linkcode.
       The expected value for this attribute is an expression
       which is compatible with :rst:dir:`only`.
 

{sphinx-8.1.1 → sphinx-8.1.3}/doc/glossary.rst

@@ -75,10 +75,8 @@ Glossary
      For more information, refer to :doc:`/usage/extensions/index`.
 
    master document
-      The document that contains the root :rst:dir:`toctree` directive.
-
    root document
-      Same as :term:`master document`.
+      The document that contains the root :rst:dir:`toctree` directive.
 
    object
       The basic building block of Sphinx documentation.  Every "object

{sphinx-8.1.1 → sphinx-8.1.3}/doc/internals/contributing.rst

@@ -270,12 +270,14 @@ you to preview in :file:`build/sphinx/html`.
 
 You can also build a **live version of the documentation** that you can preview
 in the browser. It will detect changes and reload the page any time you make
-edits. To do so, run the following command:
+edits.
+To do so, use `sphinx-autobuild`_ to run the following command:
 
 .. code-block:: shell
 
    sphinx-autobuild ./doc ./build/sphinx/
 
+.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild
 
 Translations
 ~~~~~~~~~~~~

{sphinx-8.1.1 → sphinx-8.1.3}/doc/usage/quickstart.rst

@@ -148,6 +148,17 @@ Sphinx will build HTML files.
    Refer to the :doc:`sphinx-build man page </man/sphinx-build>`
    for all options that :program:`sphinx-build` supports.
 
+You can also build a **live version of the documentation** that you can preview
+in the browser.
+It will detect changes and reload the page any time you make edits.
+To do so, use `sphinx-autobuild`_ to run the following command:
+
+.. code-block:: console
+
+   $ sphinx-autobuild source-dir output-dir
+
+.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild
+
 However, :program:`sphinx-quickstart` script creates a :file:`Makefile` and a
 :file:`make.bat` which make life even easier for you. These can be executed by
 running :command:`make` with the name of the builder. For example.

{sphinx-8.1.1 → sphinx-8.1.3}/pyproject.toml

@@ -9,6 +9,7 @@ description = "Python documentation generator"
 readme = "README.rst"
 urls.Changelog = "https://www.sphinx-doc.org/en/master/changes.html"
 urls.Code = "https://github.com/sphinx-doc/sphinx"
+urls.Documentation = "https://www.sphinx-doc.org/"
 urls.Download = "https://pypi.org/project/Sphinx/"
 urls.Homepage = "https://www.sphinx-doc.org/"
 urls."Issue tracker" = "https://github.com/sphinx-doc/sphinx/issues"
@@ -139,6 +140,8 @@ exclude = [
 [tool.mypy]
 files = [
     "doc/conf.py",
+    "doc/development/tutorials/examples/autodoc_intenum.py",
+    "doc/development/tutorials/examples/helloworld.py",
     "sphinx",
     "tests",
     "utils",

{sphinx-8.1.1 → sphinx-8.1.3}/sphinx/__init__.py

@@ -1,6 +1,6 @@
 """The Sphinx documentation toolchain."""
 
-__version__ = '8.1.1'
+__version__ = '8.1.3'
 __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, 1, 'final', 0)
+version_info = (8, 1, 3, 'final', 0)
 
 package_dir = os.path.abspath(os.path.dirname(__file__))
 

{sphinx-8.1.1 → sphinx-8.1.3}/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-8.1.1 → sphinx-8.1.3}/sphinx/ext/autodoc/__init__.py

@@ -186,7 +186,7 @@ def merge_members_option(options: dict) -> None:
 # Some useful event listener factories for autodoc-process-docstring.
 
 def cut_lines(
-    pre: int, post: int = 0, what: str | list[str] | None = None
+    pre: int, post: int = 0, what: Sequence[str] | None = None
 ) -> _AutodocProcessDocstringListener:
     """Return a listener that removes the first *pre* and last *post*
     lines of every docstring.  If *what* is a sequence of strings,
@@ -199,7 +199,12 @@ def cut_lines(
 
     This can (and should) be used in place of :confval:`automodule_skip_lines`.
     """
-    what_unique = frozenset(what or ())
+    if not what:
+        what_unique: frozenset[str] = frozenset()
+    elif isinstance(what, str):  # strongly discouraged
+        what_unique = frozenset({what})
+    else:
+        what_unique = frozenset(what)
 
     def process(
         app: Sphinx,
@@ -209,7 +214,7 @@ def cut_lines(
         options: dict[str, bool],
         lines: list[str],
     ) -> None:
-        if what_ not in what_unique:
+        if what_unique and what_ not in what_unique:
             return
         del lines[:pre]
         if post:

{sphinx-8.1.1 → sphinx-8.1.3}/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.1 → sphinx-8.1.3}/tests/test_extensions/test_ext_autodoc_events.py

@@ -58,6 +58,26 @@ def test_cut_lines(app):
     ]
 
 
+def test_cut_lines_no_objtype():
+    docstring_lines = [
+        'first line',
+        '---',
+        'second line',
+        '---',
+        'third line ',
+        '',
+    ]
+    process = cut_lines(2)
+
+    process(None, 'function', 'func', None, {}, docstring_lines)  # type: ignore[arg-type]
+    assert docstring_lines == [
+        'second line',
+        '---',
+        'third line ',
+        '',
+    ]
+
+
 @pytest.mark.sphinx('html', testroot='ext-autodoc')
 def test_between(app):
     app.connect('autodoc-process-docstring', between('---', ['function']))