From cf7da1843c45a4c2df7a749f7886a2d2ba0ee92a Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 15 Apr 2024 19:25:40 +0200 Subject: Adding upstream version 7.2.6. Signed-off-by: Daniel Baumann --- CHANGES | 9019 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 9019 insertions(+) create mode 100644 CHANGES (limited to 'CHANGES') diff --git a/CHANGES b/CHANGES new file mode 100644 index 0000000..84c7abf --- /dev/null +++ b/CHANGES @@ -0,0 +1,9019 @@ +Release 7.2.6 (released Sep 13, 2023) +===================================== + +Bugs fixed +---------- + +* #11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES` environment variable, + which if set reloads modules when using autodoc with ``TYPE_CHECKING = True``. + Patch by Matt Wozniski and Adam Turner. +* #11679: Use :py:func:`importlib.reload` to reload modules in autodoc. + Patch by Matt Wozniski and Adam Turner. + +Release 7.2.5 (released Aug 30, 2023) +===================================== + +Bugs fixed +---------- + +* #11645: Fix a regression preventing autodoc from importing modules within + packages that make use of ``if typing.TYPE_CHECKING:`` to guard circular + imports needed by type checkers. + Patch by Matt Wozniski. +* #11634: Fixed inheritance diagram relative link resolution + for sibling files in a subdirectory. + Patch by Albert Shih. +* #11659: Allow ``?config=...`` in :confval:`mathjax_path`. +* #11654: autodoc: Fail with a more descriptive error message + when an object claims to be an instance of ``type``, + but is not a class. + Patch by James Braza. +* 11620: Cease emitting :event:`source-read` events for files read via + the :dudir:`include` directive. +* 11620: Add a new :event:`include-read` for observing and transforming + the content of included files via the :dudir:`include` directive. +* #11627: Restore support for copyright lines of the form ``YYYY`` + when ``SOURCE_DATE_EPOCH`` is set. + +Release 7.2.4 (released Aug 28, 2023) +===================================== + +Bugs fixed +---------- + +* #11618: Fix a regression in the MoveModuleTargets transform, + introduced in #10478 (#9662). +* #11649: linkcheck: Resolve hanging tests for timezones west of London + and incorrect conversion from UTC to offsets from the UNIX epoch. + Patch by Dmitry Shachnev and Adam Turner. + +Release 7.2.3 (released Aug 23, 2023) +===================================== + +Dependencies +------------ + +* #11576: Require sphinxcontrib-serializinghtml 1.1.9. + +Bugs fixed +---------- + +* Fix regression in ``autodoc.Documenter.parse_name()``. +* Fix regression in JSON serialisation. +* #11543: autodoc: Support positional-only parameters in ``classmethod`` methods + when ``autodoc_preserve_defaults`` is ``True``. +* Restore support string methods on path objects. + This is deprecated and will be removed in Sphinx 8. + Use :py:func:`os.fspath` to convert :py:class:`~pathlib.Path` objects to strings, + or :py:class:`~pathlib.Path`'s methods to work with path objects. + +Release 7.2.2 (released Aug 17, 2023) +===================================== + +Bugs fixed +---------- + +* Fix the signature of the ``StateMachine.insert_input()`` patch, + for when calling with keyword arguments. +* Fixed membership testing (``in``) for the :py:class:`str` interface + of the asset classes (``_CascadingStyleSheet`` and ``_JavaScript``), + which several extensions relied upon. +* Fixed a type error in ``SingleFileHTMLBuilder._get_local_toctree``, + ``includehidden`` may be passed as a string or a boolean. +* Fix ``:noindex:`` for ``PyModule`` and ``JSModule``. + +Release 7.2.1 (released Aug 17, 2023) +===================================== + +Bugs fixed +---------- + +* Restored the the :py:class:`str` interface of the asset classes + (``_CascadingStyleSheet`` and ``_JavaScript``), which several extensions relied upon. + This will be removed in Sphinx 9. +* Restored calls to ``Builder.add_{css,js}_file()``, + which several extensions relied upon. +* Restored the private API ``TocTree.get_toctree_ancestors()``, + which several extensions relied upon. + +Release 7.2.0 (released Aug 17, 2023) +===================================== + +Dependencies +------------ + +* #11511: Drop Python 3.8 support. +* #11576: Require Pygments 2.14 or later. + +Deprecated +---------- + +* #11512: Deprecate ``sphinx.util.md5`` and ``sphinx.util.sha1``. + Use ``hashlib`` instead. +* #11526: Deprecate ``sphinx.testing.path``. + Use ``os.path`` or ``pathlib`` instead. +* #11528: Deprecate ``sphinx.util.split_index_msg`` and ``sphinx.util.split_into``. + Use ``sphinx.util.index_entries.split_index_msg`` instead. +* Deprecate ``sphinx.builders.html.Stylesheet`` + and ``sphinx.builders.html.Javascript``. + Use ``sphinx.application.Sphinx.add_css_file()`` + and ``sphinx.application.Sphinx.add_js_file()`` instead. +* #11582: Deprecate ``sphinx.builders.html.StandaloneHTMLBuilder.css_files`` and + ``sphinx.builders.html.StandaloneHTMLBuilder.script_files``. + Use ``sphinx.application.Sphinx.add_css_file()`` + and ``sphinx.application.Sphinx.add_js_file()`` instead. +* #11459: Deprecate ``sphinx.ext.autodoc.preserve_defaults.get_function_def()``. + Patch by Bénédikt Tran. + +Features added +-------------- + +* #11526: Support ``os.PathLike`` types and ``pathlib.Path`` objects + in many more places. +* #5474: coverage: Print summary statistics tables. + Patch by Jorge Leitao. +* #6319: viewcode: Add :confval:`viewcode_line_numbers` to control + whether line numbers are added to rendered source code. + Patch by Ben Krikler. +* #9662: Add the ``:no-typesetting:`` option to suppress textual output + and only create a linkable anchor. + Patch by Latosha Maltba. +* #11221: C++: Support domain objects in the table of contents. + Patch by Rouslan Korneychuk. +* #10938: doctest: Add :confval:`doctest_show_successes` option. + Patch by Trey Hunner. +* #11533: Add ``:no-index:``, ``:no-index-entry:``, and ``:no-contents-entry:``. +* #11572: Improve ``debug`` logging of reasons why files are detected as out of + date. + Patch by Eric Larson. +* #10678: Emit :event:`source-read` events for files read via + the :dudir:`include` directive. + Patch by Halldor Fannar. +* #11570: Use short names when using :pep:`585` built-in generics. + Patch by Riccardo Mori. +* #11300: Improve ``SigElementFallbackTransform`` fallback logic and signature + text elements nodes. See :doc:`the documentation ` for more + details. + Patch by Bénédikt Tran. +* Allow running Sphinx with ``python -m sphinx build ...``. + +Bugs fixed +---------- + +* #11077: graphviz: Fix relative links from within the graph. + Patch by Ralf Grubenmann. +* #11529: Line Block in LaTeX builder outputs spurious empty token. + Patch by Adrian Vollmer. +* #11196: autosummary: Summary line extraction failed with "e.g." +* #10614: Fixed a number of bugs in inheritance diagrams that resulted in + missing or broken links. + Patch by Albert Shih. +* #9428: Exclude substitution definitions when running the ``gettext`` builder. + Patch by Alvin Wong. +* #10795: Raise a descriptive error if ``graphviz_dot`` is falsy. +* #11546: Translated nodes identical to their original text are now marked + with the ``translated=True`` attribute. +* #10049: html: Change "Permalink" to "Link" for title text in link anchors. +* #4225: Relax Pygments parsing on lexing failures. +* #11246: Allow inline links in the first line of a docstring and one-line + type comments ``#: :meta ...:`` when using :mod:`sphinx.ext.napoleon`. + Patch by Bénédikt Tran. +* #10930: Highlight all search terms on the search results page. + Patch by Dmitry Shachnev. +* #11473: Type annotations containing :py:data:`~typing.Literal` enumeration + values now render correctly. + Patch by Bénédikt Tran. +* #11591: Fix support for C coverage in ``sphinx.ext.coverage`` extension. + Patch by Stephen Finucane. +* #11594: HTML Theme: Enhancements to horizontal scrolling on smaller + devices in the ``agogo`` theme. + Patch by Lukas Engelter. +* #11459: Fix support for async and lambda functions in + ``sphinx.ext.autodoc.preserve_defaults``. + Patch by Bénédikt Tran. + +Testing +------- + +* #11577: pytest: Fail tests on "XPASS". +* #11577: pytest: Use "importlib" import mode. +* #11577: pytest: Set PYTHONWARNINGS=error. +* #11577: pytest: Set strict config and strict markers. + +Release 7.1.2 (released Aug 02, 2023) +===================================== + +Bugs fixed +---------- + +* #11542: linkcheck: Properly respect :confval:`linkcheck_anchors` + and do not spuriously report failures to validate anchors. + Patch by James Addison. + +Release 7.1.1 (released Jul 27, 2023) +===================================== + +Bugs fixed +---------- + +* #11514: Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer. + Patch by Bénédikt Tran. + +Release 7.1.0 (released Jul 24, 2023) +===================================== + +Incompatible changes +-------------------- + +* Releases are no longer signed, given the `change in PyPI policy`_. + + .. _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/ + +Deprecated +---------- + +* #11412: Emit warnings on using a deprecated Python-specific index entry type + (namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``, + ``statement``, and ``builtin``) in the :rst:dir:`index` directive, and + set the removal version to Sphinx 9. Patch by Adam Turner. + +Features added +-------------- + +* #11415: Add a checksum to JavaScript and CSS asset URIs included within + generated HTML, using the CRC32 algorithm. +* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version + requirement to be specified as ``(major, minor)``. +* #11011: Allow configuring a line-length limit for object signatures, via + :confval:`maximum_signature_line_length` and the domain-specific variants. + If the length of the signature (in characters) is greater than the configured + limit, each parameter in the signature will be split to its own logical line. + This behaviour may also be controlled by options on object description + directives, for example :rst:dir:`py:function:single-line-parameter-list`. + Patch by Thomas Louf, Adam Turner, and Jean-François B. +* #10983: Support for multiline copyright statements in the footer block. + Patch by Stefanie Molin +* ``sphinx.util.display.status_iterator`` now clears the current line + with ANSI control codes, rather than overprinting with space characters. +* #11431: linkcheck: Treat SSL failures as broken links. + Patch by James Addison. +* #11157: Keep the ``translated`` attribute on translated nodes. +* #11451: Improve the traceback displayed when using :option:`sphinx-build -T` + in parallel builds. Patch by Bénédikt Tran +* #11324: linkcheck: Use session-basd HTTP requests. +* #11438: Add support for the :rst:dir:`py:class` and :rst:dir:`py:function` + directives for PEP 695 (generic classes and functions declarations) and + PEP 696 (default type parameters). Multi-line support (#11011) is enabled + for type parameters list and can be locally controlled on object description + directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`. + Patch by Bénédikt Tran. +* #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis + via :confval:`linkcheck_anchors_ignore_for_url` while + still checking the validity of the page itself. + Patch by Bénédikt Tran +* #1246: Add translation progress statistics and inspection support, + via a new substitution (``|translation progress|``) and a new + configuration variable (:confval:`translation_progress_classes`). + These enable determining the percentage of translated elements within + a document, and the remaining translated and untranslated elements. + +Bugs fixed +---------- + +* Restored the ``footnote-reference`` class that has been removed in + the latest (unreleased) version of Docutils. +* #11486: Use :rfc:`8081` font file MIME types in the EPUB builder. + Using the correct MIME type will prevent warnings from ``epubcheck`` + and will generate a valid EPUB. +* #11435: Use microsecond-resolution timestamps for outdated file detection + in ``BuildEnvironment.get_outdated_files``. +* #11437: Top-level headings starting with a reStructuredText role + now render properly when :confval:`rst_prolog` is set. + Previously, a file starting with the below would have + improperly rendered due to where the prologue text + was inserted into the document. + + .. code:: rst + + :mod:`lobster` -- The lobster module + ==================================== + + ... + + Patch by Bénédikt Tran. +* #11337: Fix a ``MemoryError`` in ``sphinx.ext.intersphinx`` when using ``None`` + or ``typing.*`` as inline type references. Patch by Bénédikt Tran (picnixz) + +Testing +------- + +* #11345: Always delete ``docutils.conf`` in test directories when running + ``SphinxTestApp.cleanup()``. + +Release 7.0.1 (released May 12, 2023) +===================================== + +Dependencies +------------ + +* #11411: Support `Docutils 0.20`_. Patch by Adam Turner. + +.. _Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04 + +Bugs fixed +---------- + +* #11418: Clean up remaining references to ``sphinx.setup_command`` + following the removal of support for setuptools. + Patch by Willem Mulder. + +Release 7.0.0 (released Apr 29, 2023) +===================================== + +Incompatible changes +-------------------- + +* #11359: Remove long-deprecated aliases for ``MecabSplitter`` and + ``DefaultSplitter`` in ``sphinx.search.ja``. +* #11360: Remove deprecated ``make_old_id`` functions in domain object + description classes. +* #11363: Remove the Setuptools integration (``build_sphinx`` hook in + ``setup.py``). +* #11364: Remove deprecated ``sphinx.ext.napoleon.iterators`` module. +* #11365: Remove support for the ``jsdump`` format in ``sphinx.search``. +* #11366: Make ``locale`` a required argument to + ``sphinx.util.i18n.format_date()``. +* #11370: Remove deprecated ``sphinx.util.stemmer`` module. +* #11371: Remove deprecated ``sphinx.pycode.ast.parse()`` function. +* #11372: Remove deprecated ``sphinx.io.read_doc()`` function. +* #11373: Removed deprecated ``sphinx.util.get_matching_files()`` function. +* #11378: Remove deprecated ``sphinx.util.docutils.is_html5_writer_available()`` + function. +* #11379: Make the ``env`` argument to ``Builder`` subclasses required. +* #11380: autosummary: Always emit grouped import exceptions. +* #11381: Remove deprecated ``style`` key for HTML templates. +* #11382: Remove deprecated ``sphinx.writers.latex.LaTeXTranslator.docclasses`` + attribute. +* #11383: Remove deprecated ``sphinx.builders.html.html5_ready`` and + ``sphinx.builders.html.HTMLTranslator`` attributes. +* #11385: Remove support for HTML 4 output. + +Release 6.2.1 (released Apr 25, 2023) +===================================== + +Bugs fixed +---------- + +* #11355: Revert the default type of :confval:`nitpick_ignore` and + :confval:`nitpick_ignore_regex` to ``list``. + +Release 6.2.0 (released Apr 23, 2023) +===================================== + +Dependencies +------------ + +* Require Docutils 0.18.1 or greater. + +Incompatible changes +-------------------- + +* LaTeX: removal of some internal TeX ``\dimen`` registers (not previously + publicly documented) as per 5.1.0 code comments in ``sphinx.sty``: + ``\sphinxverbatimsep``, ``\sphinxverbatimborder``, ``\sphinxshadowsep``, + ``\sphinxshadowsize``, and ``\sphinxshadowrule``. (refs: #11105) +* Remove ``.egg`` support from pycode ``ModuleAnalyser``; Python eggs are a + now-obsolete binary distribution format +* #11089: Remove deprecated code in ``sphinx.builders.linkcheck``. + Patch by Daniel Eades +* Remove internal-only ``sphinx.locale.setlocale`` + +Deprecated +---------- + +* #11247: Deprecate the legacy ``intersphinx_mapping`` format +* ``sphinx.util.osutil.cd`` is deprecated in favour of ``contextlib.chdir``. + +Features added +-------------- + +* #11277: :rst:dir:`autoproperty` allows the return type to be specified as + a type comment (e.g., ``# type: () -> int``). Patch by Bénédikt Tran +* #10811: Autosummary: extend ``__all__`` to imported members for template rendering + when option ``autosummary_ignore_module_all`` is set to ``False``. Patch by + Clement Pinard +* #11147: Add a ``content_offset`` parameter to ``nested_parse_with_titles()``, + allowing for correct line numbers during nested parsing. + Patch by Jeremy Maitin-Shepard +* Update to Unicode CLDR 42 +* Add a ``--jobs`` synonym for ``-j``. Patch by Hugo van Kemenade +* LaTeX: a command ``\sphinxbox`` for styling text elements with a (possibly + rounded) box, optional background color and shadow, has been added. + See :ref:`sphinxbox`. (refs: #11224) +* LaTeX: add ``\sphinxstylenotetitle``, ..., ``\sphinxstylewarningtitle``, ..., + for an extra layer of mark-up freeing up ``\sphinxstrong`` for other uses. + See :ref:`latex-macros`. (refs: #11267) +* LaTeX: :dudir:`note`, :dudir:`hint`, :dudir:`important` and :dudir:`tip` can + now each be styled as the other admonitions, i.e. possibly with a background + color, individual border widths and paddings, possibly rounded corners, and + optional shadow. See :ref:`additionalcss`. (refs: #11234) +* LaTeX: admonitions and :dudir:`topic` (and + :dudir:`contents `) directives, and not only + :rst:dir:`code-block`, support ``box-decoration-break=slice``. +* LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: #11243) +* LaTeX: new options ``noteTextColor``, ``noteTeXextras`` et al. + See :ref:`additionalcss`. +* LaTeX: support elliptical corners in rounded boxes. (refs: #11254) +* #11150: Include source location in highlighting warnings, when lexing fails. + Patch by Jeremy Maitin-Shepard +* #11281: Support for :confval:`imgmath_latex` ``= 'tectonic'`` or + ``= 'xelatex'``. Patch by Dimitar Dimitrov +* #11109, #9643: Add :confval:`python_display_short_literal_types` option for + condensed rendering of ``Literal`` types. + +Bugs fixed +---------- + +* #11079: LaTeX: figures with align attribute may disappear and strangely impact + following lists +* #11093: LaTeX: fix "multiply-defined references" PDF build warnings when one or + more reST labels directly precede an :rst:dir:`py:module` or :rst:dir:`automodule` + directive. Patch by Bénédikt Tran (picnixz) +* #11110: LaTeX: Figures go missing from latex pdf if their files have the same + base name and they use a post transform. Patch by aaron-cooper +* LaTeX: fix potential color leak from shadow to border of rounded boxes, if + shadow color is set but border color is not +* LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames + respective to contents (when using rounded corners) +* #11235: LaTeX: added ``\color`` in topic (or admonition) contents may cause color + leak to the shadow and border at a page break +* #11264: LaTeX: missing space before colon after "Voir aussi" for :rst:dir:`seealso` + directive in French +* #11268: LaTeX: longtable with left alignment breaks out of current list + indentation context in PDF. Thanks to picnixz. +* #11274: LaTeX: external links are not properly escaped for ``\sphinxupquote`` + compatibility +* #11147: Fix source file/line number info in object description content and in + other uses of ``nested_parse_with_titles``. Patch by Jeremy Maitin-Shepard. +* #11192: Restore correct parallel search index building. + Patch by Jeremy Maitin-Shepard +* Use the new Transifex ``tx`` client + +Testing +------- + +* Fail testing when any Python warnings are emitted +* Migrate remaining ``unittest.TestCase`` style test functions to pytest style +* Remove tests that rely on setuptools + +Release 6.1.3 (released Jan 10, 2023) +===================================== + +Bugs fixed +---------- + +* #11116: Reverted to previous Sphinx 5 node copying method +* #11117: Reverted changes to parallel image processing from Sphinx 6.1.0 +* #11119: Supress ``ValueError`` in the ``linkcheck`` builder + +Release 6.1.2 (released Jan 07, 2023) +===================================== + +Bugs fixed +---------- + +* #11101: LaTeX: ``div.topic_padding`` key of sphinxsetup documented at 5.1.0 was + implemented with name ``topic_padding`` +* #11099: LaTeX: ``shadowrule`` key of sphinxsetup causes PDF build to crash + since Sphinx 5.1.0 +* #11096: LaTeX: ``shadowsize`` key of sphinxsetup causes PDF build to crash + since Sphinx 5.1.0 +* #11095: LaTeX: shadow of :dudir:`topic` and :dudir:`contents ` + boxes not in page margin since Sphinx 5.1.0 +* #11100: Fix copying images when running under parallel mode. + +Release 6.1.1 (released Jan 05, 2023) +===================================== + +Bugs fixed +---------- + +* #11091: Fix ``util.nodes.apply_source_workaround`` for ``literal_block`` nodes + with no source information in the node or the node's parents. + +Release 6.1.0 (released Jan 05, 2023) +===================================== + +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 + 5.1.0 + +Release 6.0.1 (released Jan 05, 2023) +===================================== + +Dependencies +------------ + +* Require Pygments 2.13 or later. + +Bugs fixed +---------- + +* #10944: imgmath: Fix resolving image paths for files in nested folders. + +Release 6.0.0 (released Dec 29, 2022) +===================================== + +Dependencies +------------ + +* #10468: Drop Python 3.6 support +* #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and + Docutils 0.17 support. Patch by Adam Turner + +Incompatible changes +-------------------- + +* #7405: Removed the jQuery and underscore.js JavaScript frameworks. + + These frameworks are no longer be automatically injected into themes from + Sphinx 6.0. If you develop a theme or extension that uses the + ``jQuery``, ``$``, or ``$u`` global objects, you need to update your + JavaScript to modern standards, or use the mitigation below. + + The first option is to use the sphinxcontrib.jquery_ extension, which has been + developed by the Sphinx team and contributors. To use this, add + ``sphinxcontrib.jquery`` to the ``extensions`` list in ``conf.py``, or call + ``app.setup_extension("sphinxcontrib.jquery")`` if you develop a Sphinx theme + or extension. + + The second option is to manually ensure that the frameworks are present. + To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and + ``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory, + and add the following to your ``layout.html``: + + .. code-block:: html+jinja + + {%- block scripts %} + + + {{ super() }} + {%- endblock %} + + .. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/ + + Patch by Adam Turner. +* #10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See + :ref:`dev-deprecated-apis` for details. Patch by Adam Turner. +* #10901: C Domain: Remove support for parsing pre-v3 style type directives and + roles. Also remove associated configuration variables ``c_allow_pre_v3`` and + ``c_warn_on_allowed_pre_v3``. Patch by Adam Turner. + +Features added +-------------- + +* #10924: LaTeX: adopt better looking defaults for tables and code-blocks. + See :confval:`latex_table_style` and the ``pre_border-radius`` and + ``pre_background-TeXcolor`` :ref:`additionalcss` for the former defaults + and how to re-enact them if desired. + +Bugs fixed +---------- + +* #10984: LaTeX: Document :confval:`latex_additional_files` behavior for files + with ``.tex`` extension. + +Release 5.3.0 (released Oct 16, 2022) +===================================== + +* #10759: LaTeX: add :confval:`latex_table_style` and support the + ``'booktabs'``, ``'borderless'``, and ``'colorrows'`` styles. + (thanks to Stefan Wiehler for initial pull requests #6666, #6671) +* #10840: One can cross-reference including an option value like ``:option:`--module=foobar```, + ``:option:`--module[=foobar]``` or ``:option:`--module foobar```. + Patch by Martin Liska. +* #10881: autosectionlabel: Record the generated section label to the debug log. +* #10268: Correctly URI-escape image filenames. +* #10887: domains: Allow sections in all the content of all object description + directives (e.g. :rst:dir:`py:function`). Patch by Adam Turner + +Release 5.2.3 (released Sep 30, 2022) +===================================== + +* #10878: Fix base64 image embedding in ``sphinx.ext.imgmath`` +* #10886: Add ``:nocontentsentry:`` flag and global domain table of contents + entry control option. Patch by Adam Turner + +Release 5.2.2 (released Sep 27, 2022) +===================================== + +* #10872: Restore link targets for autodoc modules to the top of content. + Patch by Dominic Davis-Foster. + +Release 5.2.1 (released Sep 25, 2022) +===================================== + +Bugs fixed +---------- + +* #10861: Always normalise the ``pycon3`` lexer to ``pycon``. +* Fix using ``sphinx.ext.autosummary`` with modules containing titles in the + module-level docstring. + +Release 5.2.0.post0 (released Sep 24, 2022) +=========================================== + +* Recreated source tarballs for Debian maintainers. + +Release 5.2.0 (released Sep 24, 2022) +===================================== + +Dependencies +------------ + +* #10356: Sphinx now uses declarative metadata with ``pyproject.toml`` to + create packages, using PyPA's ``flit`` project as a build backend. Patch by + Adam Turner. + +Deprecated +---------- + +* #10843: Support for HTML 4 output. Patch by Adam Turner. + +Features added +-------------- + +* #10738: napoleon: Add support for docstring types using 'of', like + ``type of type``. Example: ``tuple of int``. +* #10286: C++, support requires clauses not just between the template + parameter lists and the declaration. +* #10755: linkcheck: Check the source URL of raw directives that use the ``url`` + option. +* #10781: Allow :rst:role:`ref` role to be used with definitions and fields. +* #10717: HTML Search: Increase priority for full title and + subtitle matches in search results +* #10718: HTML Search: Save search result score to the HTML element for debugging +* #10673: Make toctree accept 'genindex', 'modindex' and 'search' docnames +* #6316, #10804: Add domain objects to the table of contents. Patch by Adam Turner +* #6692: HTML Search: Include explicit :rst:dir:`index` directive index entries + in the search index and search results. Patch by Adam Turner +* #10816: imgmath: Allow embedding images in HTML as base64 +* #10854: HTML Search: Use browser localstorage for highlight control, stop + storing highlight parameters in URL query strings. Patch by Adam Turner. + +Bugs fixed +---------- + +* #10723: LaTeX: 5.1.0 has made the 'sphinxsetup' ``verbatimwithframe=false`` + become without effect. +* #10257: C++, ensure consistent non-specialization template argument + representation. +* #10729: C++, fix parsing of certain non-type template parameter packs. +* #10715: Revert #10520: "Fix" use of sidebar classes in ``agogo.css_t`` + +Release 5.1.1 (released Jul 26, 2022) +===================================== + +Bugs fixed +---------- + +* #10701: Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean`` + iterator implementation. +* #10702: Restore compatability with third-party builders. + +Release 5.1.0 (released Jul 24, 2022) +===================================== + +Dependencies +------------ + +* #10656: Support `Docutils 0.19`_. Patch by Adam Turner. + +.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05 + +Deprecated +---------- + +* #10467: Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``. + Patch by Adam Turner. +* #9856: Deprecated ``sphinx.ext.napoleon.iterators``. + +Features added +-------------- + +* #10444: html theme: Allow specifying multiple CSS files through the ``stylesheet`` + setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings. +* #10366: std domain: Add support for emphasising placeholders in :rst:dir:`option` + directives through a new :confval:`option_emphasise_placeholders` configuration + option. +* #10439: std domain: Use the repr of some variables when displaying warnings, + making whitespace issues easier to identify. +* #10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by + Pradyun Gedam. +* #10648: LaTeX: CSS-named-alike additional :ref:`'sphinxsetup' ` + keys allow to configure four separate border-widths, four paddings, four + corner radii, a shadow (possibly inset), colours for border, background, shadow + for each of the code-block, topic, attention, caution, danger, error and warning + directives. +* #10655: LaTeX: Explain non-standard encoding in LatinRules.xdy +* #10599: HTML Theme: Wrap consecutive footnotes in an ``