From 223bb317a741957470d07dd00963f14ab05e70ef Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Wed, 4 Jan 2023 16:51:26 +0000 Subject: [PATCH] Updated CHANGES for Sphinx 6.1.0 --- CHANGES | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/CHANGES b/CHANGES index 3b85a5c879f..a8b8b002740 100644 --- a/CHANGES +++ b/CHANGES @@ -4,18 +4,62 @@ Release 6.1.0 (in development) Dependencies ------------ +* Adopted the `Ruff`_ code linter. + + .. _Ruff: https://github.com/charliermarsh/ruff + Incompatible changes -------------------- +* #10979: gettext: Removed support for pluralisation in ``get_translation``. + This was unused and complicated other changes to ``sphinx.locale``. + Deprecated ---------- +* ``sphinx.util`` functions: + + * Renamed ``sphinx.util.typing.stringify()`` + to ``sphinx.util.typing.stringify_annotation()`` + * Moved ``sphinx.util.xmlname_checker()`` + to ``sphinx.builders.epub3._XML_NAME_PATTERN`` + + Moved to ``sphinx.util.display``: + + * ``sphinx.util.status_iterator`` + * ``sphinx.util.display_chunk`` + * ``sphinx.util.SkipProgressMessage`` + * ``sphinx.util.progress_message`` + + Moved to ``sphinx.util.http_date``: + + * ``sphinx.util.epoch_to_rfc1123`` + * ``sphinx.util.rfc1123_to_epoch`` + + Moved to ``sphinx.util.exceptions``: + + * ``sphinx.util.save_traceback`` + * ``sphinx.util.format_exception_cut_frames`` + Features added -------------- +* Cache doctrees in the build environment during the writing phase. +* Make all writing phase tasks support parallel execution. +* #11072: Use PEP 604 (``X | Y``) display conventions for ``typing.Optional`` + and ``typing.Optional`` types within the Python domain and autodoc. +* #10700: autodoc: Document ``typing.NewType()`` types as classes rather than + 'data'. +* Cache doctrees between the reading and writing phases. + Bugs fixed ---------- +* #10962: HTML: Fix the multi-word key name lookup table. +* Fixed support for Python 3.12 alpha 3 (changes in the ``enum`` module). +* #11069: HTML Theme: Removed outdated "shortcut" link relation keyword. +* #10952: Properly terminate parallel processes on programme interuption. +* #10988: Speed up ``TocTree.resolve()`` through more efficient copying. * #6744: LaTeX: support for seealso directive should be via an environment to allow styling. * #11074: LaTeX: Can't change sphinxnote to use sphinxheavybox starting with