* Fri Jan 17 2025 Markéta Machová - Add pygments.patch to fix tests with Pygments 2.19 * Wed Nov 20 2024 Dirk Müller - update to 8.1.3: * #13013: Restore support for :func:`!cut_lines` with no object type. Patch by Adam Turner. * #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. * #13006: Use the preferred https://www.cve.org/ URL for the :rst:role:`:cve: ` role. Patch by Hugo van Kemenade. * #13007: LaTeX: Improve resiliency when the required fontawesome or fontawesome5 packages are not installed. Patch by Jean-François B. * #12756: Add lower-bounds to the sphinxcontrib- * dependencies. Patch by Adam Turner. * #12833: Update the LaTeX parskip package from 2001 to 2018. Patch by Jean-François B. * #12763: Remove unused internal class sphinx.util.Tee. Patch by Adam Turner. * #12822: LaTeX: for Unicode engines, the :ref:`fvset` default is changed to \'\\fvset{fontsize=auto}\' from \'\\fvset{fontsize=\\small}\'. Code-blocks are unchanged as FreeMono is now loaded with Scale=0.9. An adjustment to existing projects is needed only if they used a custom :ref:`fontpkg` configuration and did not set :ref:`fvset`. Patch by Jean-François B. * #12875: Disable smartquotes for languages: zh_CN and zh_TW by default. Patch by A. Rafey Khan. * #12762: Deprecate sphinx.util.import_object. Use :py:func:`importlib.import_module` instead. Patch by Adam Turner. * #12766: Deprecate sphinx.util.FilenameUniqDict and sphinx.util.DownloadFiles. Patch by Adam Turner. * #11328: Mention evaluation of templated content during production of static output files. Patch by James Addison. * #12704: LaTeX: make :dudir:`contents `, :dudir:`topic`, and :dudir:`sidebar` directives separately customizable for PDF output. Patch by Jean-François B. and Bénédikt Tran. * #12474: Support type-dependent search result highlighting via CSS. Patch by Tim Hoffmann. * #12652: LaTeX: Add :confval:`math_numsep` support to latex builder. Patch by Thomas Fanning and Jean-François B. * #12743: No longer exit on the first warning when :option:`--fail-on-warning ` is used. Instead, exit with a non-zero status if any warnings were generated during the build. Patch by Adam Turner. * #12743: Add :option:`sphinx-build --exception-on-warning`, to raise an exception when warnings are emitted during the build. Patch by Adam Turner and Jeremy Maitin-Shepard. * #12907: Add :confval:`html_last_updated_use_utc` to allow using universal time (GMT/UTC) instead of local time for the date-time supplied to :confval:`html_last_updated_fmt`. Patch by Adam Turner. * #12910: Copyright entries now support the \'%Y\' placeholder to substitute the current year. This is helpful for reducing the reliance on Python modules such as :py:mod:`time` or :py:mod:`datetime` in :file:`conf.py`. See :ref:`the docs ` for further detail. Patch by Adam Turner. * #11781: Add roles for referencing CVEs (:rst:role:`:cve: `) and CWEs (:rst:role:`:cwe: `). Patch by Hugo van Kemenade. * #11809: Improve the formatting for RFC section anchors. Patch by Jakub Stasiak and Adam Turner. * #12852: Support a :attr:`.Builder.supported_linkcode` attribute for builders to enable use of :mod:`sphinx.ext.linkcode`-generated references. Patch by James Knight. * #12949: Print configuration options that differ from the pickled environment. This can be helpful in diagnosing the cause of a full rebuild. Patch by Adam Turner. * #12514: intersphinx: fix the meaning of a negative value for :confval:`intersphinx_cache_limit`. Patch by Shengyu Zhang. * #12722: LaTeX: avoid TeX reporting Overfull \\hbox from too long strings in a codeline when the problem has actually been solved thanks to :ref:`latexsphinxsetupforcewraps`. Patch by Jean-François B. * #12730: The UnreferencedFootnotesDetector transform has been improved to more consistently detect unreferenced footnotes. Note, the priority of the transform has been changed from 200 to 622, so that it now runs after the docutils Footnotes resolution transform. Patch by Chris Sewell. * #12778: LaTeX: let :ref:`\'sphinxsetup\' ` div.topic_box-shadow key if used with only one dimension set both x-offset and y-offset as per documentation. Patch by Jean-François B. * #12587: Do not warn when potential ambiguity detected during Intersphinx resolution occurs due to duplicate targets that differ case-insensitively. Patch by James Addison. * #12639: Fix singular and plural search results text. Patch by Hugo van Kemenade. * #12645: Correctly support custom gettext output templates. Patch by Jeremy Bowman. * #12717: LaTeX: let :option:`-q ` (quiet) option for :program:`sphinx-build -M latexpdf` or :program:`make latexpdf` (O=-q) get passed to :program:`latexmk`. Let :option:`-Q ` (silent) apply as well to the PDF build phase. Patch by Jean- François B. * #12744: LaTeX: Classes injected by a custom interpreted text role now give rise to nested \\DUrole\'s, rather than a single one with comma separated classes. Patch by Jean-François B. * #12831: LaTeX: avoid large voids sometimes occurring at page bottoms. Patch by Jean-François B. * #11970, #12551: singlehtml builder: make target URIs to be same-document references in the sense of :rfc:`RFC 3986, §4.4 <3986#section-4.4>`, e.g., index.html#foo becomes #foo. (note: continuation of a partial fix added in Sphinx 7.3.0) Patch by James Addison (with reference to prior work by Eric Norige). * #12735: Fix PEP 695 generic classes LaTeX output formatting. Patch by Jean-François B. and Bénédikt Tran. * #12782: intersphinx: fix double forward slashes when generating the inventory file URL (user-defined base URL of an intersphinx project are left untouched even if they end with double forward slashes). Patch by Bénédikt Tran. * #12796: Enable parallel reading if requested, even if there are fewer than 6 documents. Patch by Matthias Geier. * #12844: Restore support for :noindex: for the :rst:dir:`js:module` and :rst:dir:`py:module` directives. Patch by Stephen Finucane. * #12916: Restore support for custom templates named with the legacy _t suffix during apidoc RST rendering (regression in 7.4.0). Patch by James Addison. * #12451: Only substitute copyright notice years with values from SOURCE_DATE_EPOCH for entries that match the current system clock year, and disallow substitution of future years. Patch by James Addison and Adam Turner. * #12905: intersphinx: fix flipped use of :confval:`intersphinx_cache_limit`, which always kept the cache for positive values, and always refreshed it for negative ones. Patch by Nico Madysa. * #12888: Add a warning when document is included in multiple toctrees and ensure deterministic resolution of global toctree in parallel builds by choosing the lexicographically greatest parent document. Patch by A. Rafey Khan * #12995: Significantly improve performance when building the search index for Chinese languages. Patch by Adam Turner. * #12767: :py:meth:`.Builder.write` is typed as final, meaning that the :event:`write-started` event may be relied upon by extensions. A new :py:meth:`.Builder.write_documents` method has been added to control how documents are written. This is intended for builders that do not output a file for each document. Patch by Adam Turner. * #12141: Migrate from the deprecated karma JavaScript test framework to the actively-maintained jasmine framework. Test coverage is unaffected. Patch by James Addison. * Sun Sep 01 2024 Christoph G - update to 8.0.2 * #12633: Drop Python 3.9 support. * Remove deprecated functions from sphinx.util: + Removed sphinx.util.path_stabilize (use sphinx.util.osutil.path_stabilize). + Removed sphinx.util.display_chunk (use sphinx.util.display.display_chunk). + Removed sphinx.util.status_iterator (use sphinx.util.display.status_iterator). + Removed sphinx.util.SkipProgressMessage (use sphinx.util.display.SkipProgressMessage). + Removed sphinx.util.progress_message (use sphinx.util.display.progress_message). + Removed sphinx.util.epoch_to_rfc1123 (use sphinx.http_date.epoch_to_rfc1123). + Removed sphinx.util.rfc1123_to_epoch (use sphinx.http_date.rfc1123_to_epoch). + Removed sphinx.util.save_traceback (use sphinx.exceptions.save_traceback). + Removed sphinx.util.format_exception_cut_frames (use sphinx.exceptions.format_exception_cut_frames). + Removed sphinx.util.xmlname_checker (use sphinx.builders.epub3._XML_NAME_PATTERN). + Removed sphinx.util.osutil.cd() (use contextlib.chdir()). + Removed sphinx.util.typing.stringify() (use sphinx.util.typing.stringify_annotation()). * #12593: Raise an error for invalid html_sidebars values. * #12593: Raise an error in Theme.get_config() for invalid sections. * #11693: Remove support for old-style Makefile and make.bat output in sphinx-quickstart. * #11693: Remove the --no-use-make-mode, -M, --use-make-mode, and -m options from sphinx-quickstart. * Removed the tuple interface to sphinx.ext.autodoc.ObjectMember. * #12630: Sphinx 8 makes two changes to the linkcheck configuration defaults: + linkcheck_allow_unauthorized is now False by default. + linkcheck_report_timeouts_as_broken is now False by default. * #12597: Change the default of show_warning_types from False to True. * #12083: Remove support for the old (2008–2010) Sphinx 0.5 and Sphinx 0.6 intersphinx_mapping format. * #12096: Do not overwrite user-supplied files when copying assets unless forced with force=True. * #12646: Remove sphinx.util.inspect.isNewType(). Use isinstance(obj, typing.NewType) instead on Python 3.10 and newer. * Remove the long-deprecated (since Sphinx 2) alias to VersionChange in sphinx.directives.other (Deprecated since Sphinx 2). Use sphinx.domains.changeset.VersionChange directly. * Thu Jul 18 2024 Dirk Müller - update to 7.4.5: * #12593, #12600: Revert coercing the type of selected :confval:`html_sidebars` values to a list. Log an error message when string values are detected. Patch by Adam Turner. * #12594: LaTeX: since 7.4.0, :rst:dir:`seealso` and other \"light\" admonitions now break PDF builds if they contain a :dudir:`figure` directive; and also if they are contained in a table cell (rendered by tabulary). Patch by Jean-François B. * #12585, #12586: Do not warn when an intersphinx inventory contains case-insensitively ambiguous duplicate items. Patch by James Addison. * #12582: Restore support for list-styled :confval:`source_suffix` values with extensions that register parsers. Patch by Adam Turner. * #12580, #12583: Resolve failures with the C domain on incremental builds with Sphinx 7.3.7 and earlier. Patch by Adam Turner. * Fix invalid HTML when a rubric node with invalid heading- level is used. Patch by Adam Turner. * #12579, #12581: Restore support for typing.ParamSpec in autodoc. Patch by Adam Turner. * #12555: Drop Docutils 0.18.1 and Docutils 0.19 support. Patch by Adam Turner. * LaTeX: the xcolor package is now required (but is for example part of Ubuntu texlive-latex-recommended which has always been required). * LaTeX: the fontawesome5 LaTeX package is needed for the default choices of icons now used in admonition titles in PDF output; but if unavailable the PDF build will simply silently omit rendering such icons. Check the documentation of the iconpackage key of :ref:`\'sphinxsetup\' ` for more. * LaTeX: the sphinxlightbox environment is not used anymore, all types of admonitions use (by default) only sphinxheavybox. * #11165: Support the officially recommended .jinja suffix for template files. Patch by James Addison and Adam Turner * #11165: Support the officially recommended .jinja suffix for template files. Patch by James Addison and Adam Turner * #12325: Flatten Union[Literal[T], Literal[U], ...] to Literal[T, U, ...] when turning annotations into strings. Patch by Adam Turner. * #12325: Flatten Union[Literal[T], Literal[U], ...] to Literal[T, U, ...] when turning annotations into strings. Patch by Adam Turner. * #12319: sphinx.ext.extlinks: Add extlink-{name} CSS class to links. Patch by Hugo van Kemenade. * #12319: sphinx.ext.extlinks: Add extlink-{name} CSS class to links. Patch by Hugo van Kemenade. * #12387: Improve CLI progress message, when copying assets. Patch by INADA Nakoi and Bénédikt Tran. * #12387: Improve CLI progress message, when copying assets. Patch by INADA Nakoi and Bénédikt Tran. * #12361: Add :attr:`.BuildEnvironment.parser`. Patch by Chris Sewell. * #12361: Add :attr:`.BuildEnvironment.parser`. Patch by Chris Sewell. * #12358: Add :attr:`.Sphinx.fresh_env_used`. Patch by Chris Sewell. * #12358: Add :attr:`.Sphinx.fresh_env_used`. Patch by Chris Sewell. * #12329: Add detection of ambiguous std:label and std:term references during loading and resolution of Intersphinx targets. Patch by James Addison. * #12329: Add detection of ambiguous std:label and std:term references during loading and resolution of Intersphinx targets. Patch by James Addison. * #12422: Do not duplicate \"navigation\" in aria-label of built- in themes. Patch by Thomas Weißschuh * #12422: Do not duplicate \"navigation\" in aria-label of built- in themes. Patch by Thomas Weißschuh * #12421: Include project name in logo_alt of built-in themes. Patch by Thomas Weißschuh * #12421: Include project name in logo_alt of built-in themes. Patch by Thomas Weißschuh * #12448: Add :option:`sphinx-apidoc --remove-old` option. Patch by Chris Sewell. * #12448: Add :option:`sphinx-apidoc --remove-old` option. Patch by Chris Sewell. * #12456: Add :option:`sphinx-autogen --remove-old` option. Patch by Chris Sewell. * #12456: Add :option:`sphinx-autogen --remove-old` option. Patch by Chris Sewell. * #12479: Add warning subtype toc.no_title. Patch by Ondřej Navrátil. * #12479: Add warning subtype toc.no_title. Patch by Ondřej Navrátil. * #12492: Add helper methods for parsing reStructuredText content into nodes from within a directive. :py:meth:`~sphin x.util.docutils.SphinxDirective.parse_content_to_nodes()` parses the directive\'s content and returns a list of Docutils nodes. :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_ text_to_nodes()` parses the provided text and returns a list of Docutils nodes. :py:meth:`~sphinx.util.docutils.SphinxDire ctive.parse_inline()` parses the provided text into inline elements and text nodes. Patch by Adam Turner. * #12492: Add helper methods for parsing reStructuredText content into nodes from within a directive. * :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_content _to_nodes()` parses the directive\'s content and returns a list of Docutils nodes. * :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_text_to _nodes()` parses the provided text and returns a list of Docutils nodes. * :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_inline( )` parses the provided text into inline elements and text nodes. * Patch by Adam Turner. * #12258: Support typing_extensions.Unpack Patch by Bénédikt Tran and Adam Turner. * #12258: Support typing_extensions.Unpack Patch by Bénédikt Tran and Adam Turner. * #12524: Add a class option to the :rst:dir:`toctree` directive. Patch by Tim Hoffmann. * #12524: Add a class option to the :rst:dir:`toctree` directive. Patch by Tim Hoffmann. * #12536: Add the :rst:dir:`confval` directive. Patch by Adam Turner. * #12536: Add the :rst:dir:`confval` directive. Patch by Adam Turner. * #12537: :confval:`c_id_attributes`, :confval:`c_paren_attributes`, :confval:`cpp_id_attributes`, and :confval:`cpp_paren_attributes` can now be a tuple of strings. :confval:`c_extra_keywords`, :confval:`gettext_additional_targets`, :confval:`html_domain_indices`, :confval:`latex_domain_indices`, and :confval:`texinfo_domain_indices`, can now be a set of strings. Patch by Adam Turner. * #12537: :confval:`c_id_attributes`, :confval:`c_paren_attributes`, :confval:`cpp_id_attributes`, and :confval:`cpp_paren_attributes` can now be a tuple of strings. :confval:`c_extra_keywords`, :confval:`gettext_additional_targets`, :confval:`html_domain_indices`, :confval:`latex_domain_indices`, and :confval:`texinfo_domain_indices`, can now be a set of strings. Patch by Adam Turner. * #12523: Added configuration option, :confval:`math_numsep`, to define the separator for math numbering. Patch by Thomas Fanning * #12523: Added configuration option, :confval:`math_numsep`, to define the separator for math numbering. Patch by Thomas Fanning * #11592: Add :confval:`coverage_modules` to the coverage builder to allow explicitly specifying which modules should be documented. Patch by Stephen Finucane. * #11592: Add :confval:`coverage_modules` to the coverage builder to allow explicitly specifying which modules should be documented. Patch by Stephen Finucane. * #7896, #11989: Add a :rst:dir:`py:type` directive for documenting type aliases, and a :rst:role:`py:type` role for linking to them. Patch by Ashley Whetter. * #7896, #11989: Add a :rst:dir:`py:type` directive for documenting type aliases, and a :rst:role:`py:type` role for linking to them. Patch by Ashley Whetter. * #12549: Add optional description argument to :meth:`.Sphinx.add_config_value`. Patch by Chris Sewell. * #12549: Add optional description argument to :meth:`.Sphinx.add_config_value`. Patch by Chris Sewell. * #6792: Prohibit module import cycles in :mod:`sphinx.ext.autosummary`. Patch by Trevor Bekolay. * #6792: Prohibit module import cycles in :mod:`sphinx.ext.autosummary`. Patch by Trevor Bekolay. * #12508: LaTeX: Revamped styling of all admonitions, with addition of a title row with icon. Patch by Jean-François B. * #12508: LaTeX: Revamped styling of all admonitions, with addition of a title row with icon. Patch by Jean-François B. * #11773: Display :py:class:`~typing.Annotated` annotations with their metadata in the Python domain. Patch by Adam Turner and David Stansby. * #11773: Display :py:class:`~typing.Annotated` annotations with their metadata in the Python domain. Patch by Adam Turner and David Stansby. * #12506: Add heading-level option to :rst:dir:`rubric` directive. Patch by Chris Sewell. * #12506: Add heading-level option to :rst:dir:`rubric` directive. Patch by Chris Sewell. * #12567: Add the :event:`write-started` event. Patch by Chris Sewell. * #12567: Add the :event:`write-started` event. Patch by Chris Sewell. * #12314: Properly format collections.abc.Callable in annotations. Patch by Adam Turner. * #12162: Fix a performance regression in the C domain that has been present since version 3.0.0. Patch by Donald Hunter. * #12320: Fix removal of anchors from search summaries (regression in 7.3.0). Patch by Will Lachance. * #12251: Fix merge_domaindata() in sphinx.ext.duration. Patch by Matthias Geier. * #12224: Properly detect WebP files. Patch by Benjamin Cabé. * #12380: LaTeX: Footnote mark sometimes indicates Page N where N is the current page number and the footnote does appear on that same page. Patch by Jean-François B. * #12410: LaTeX: for French and \'lualatex\' as :confval:`latex_engine` polyglossia and not babel is used (contrarily to \'xelatex\'). Patch by Jean-François B. * #12416: Ensure that configuration setting aliases are always synchronised when one value or the other is modified. Patch by Bénédikt Tran. * #12220: Fix loading custom template translations for en locale. Patch by Nicolas Peugnet. * #12459: Add valid-type arguments to the linkcheck_rate_limit_timeout configuration setting. Patch by James Addison. * #12331: Resolve data-URI-image-extraction regression from v7.3.0 affecting builders without native support for data- URIs in their output format. Patch by James Addison. * #12494: Fix invalid genindex.html file produced with translated docs (regression in 7.1.0). Patch by Nicolas Peugnet. * #11961: Omit anchor references from document title entries in the search index, removing duplication of search results. Patch by James Addison. * #12425: Use Docutils\' SVG processing in the HTML builder and remove Sphinx\'s custom logic. Patch by Tunç Başar Köse. * #12391: Adjust scoring of matches during HTML search so that document main titles tend to rank higher than subsection titles. In addition, boost matches on the name of programming domain objects relative to title/subtitle matches. Patch by James Addison and Will Lachance. * #9634: Do not add a fallback language by stripping the country code. Patch by Alvin Wong. * #12352: Add domain objects to the table of contents in the same order as defined in the document. Previously, each domain used language-specific nesting rules, which removed control from document authors. Patch by Jakob Lykke Andersen and Adam Turner. * #11041: linkcheck: Ignore URLs that respond with non-Unicode content. Patch by James Addison. * #12543: Fix PEP 695 formatting for LaTeX output. Patch by Bénédikt Tran. * karma: refactor HTML search tests to use fixtures generated by Sphinx. Patch by James Addison. * Sat Jun 29 2024 Dirk Müller - update to 7.3.7: * #12299: Defer loading themes defined via entry points until their explicit use by the user or a child theme. Patch by Adam Turner. * #12305: Return the default value for theme.get_config() with an unsupported theme configuration section. Patch by Adam Turner. * #12295: Re-export all AST types in the C and C++ domains. Patch by Adam Turner. * #12295: Re-export various objects from sphinx.domains.python._annotations in sphinx.domains.python. Patch by Jacob Chesslo and Adam Turner. * #12295: Re-export various objects from sphinx.domains.python._object in sphinx.domains.python. Patch by Jacob Chesslo and Adam Turner. * Handle cases when Any is not an instance of type. Patch by Adam Turner. * #12290: Fix a false-positive warning when setting a configuration value with Any as the valid type to a type other than the value\'s default. Patch by Adam Turner. * Preload all themes defined via entry points. Patch by Adam Turner. * Fix a bad interaction between the \'Furo\' theme and the new- style for configuration values. Patch by Adam Turner. * Require tomli on Python 3.10 and earlier. Patch by Adam Turner. * #11858: Increase the minimum supported version of Alabaster to 0.7.14. Patch by Adam Turner. * #11411: Support Docutils 0.21. Patch by Adam Turner. * #12012: Use types-docutils instead of docutils-stubs. * #11693: Support for old-style :file:`Makefile` and :file:`make.bat` output in :program:`sphinx-quickstart`, and the associated options :option:`!-M`, :option:`!-m`, :option:`!--no-use-make-mode`, and :option:`!--use-make- mode`. * #11285: Direct access to :attr:`!sphinx.testing.util.SphinxTestApp._status` or :attr:`!sphinx.testing.util.SphinxTestApp._warning` is deprecated. Use the public properties :attr:`!sphinx.testing.util.SphinxTestApp.status` and :attr:`!sphinx.testing.util.SphinxTestApp.warning` instead. Patch by Bénédikt Tran. * tests: :func:`!sphinx.testing.util.strip_escseq` is deprecated in favour of :func:`!sphinx.util.console.strip_colors`. Patch by Bénédikt Tran. * #12265: Support theme configuration via theme.toml. * #11701: HTML Search: Adopt the new element. Patch by Bénédikt Tran. * #11776: Add long option names to sphinx-build. Patch by Hugo van Kemenade, Adam Turner, Bénédikt Tran, and Ezio Melotti. * Organise the sphinx-build options into groups. Patch by Adam Turner. * #11855: Defer computation of configuration values. Patch by Adam Turner. * Add :no-search: as an alias of the :nosearch: metadata field. Patch by Adam Turner. * #11803: autodoc: Use an overriden __repr__() function in an enum, if defined. Patch by Shengyu Zhang. * #11825: Allow custom targets in the manpage role. Patch by Nicolas Peugnet. * #11892: Improved performance when resolving cross references in the C++ domain. Patch by Rouslan Korneychuk. * #11905: Add a :rst:dir:`versionremoved` directive. Patch by Hugo van Kemenade, Adam Turner, and C.A.M. Gerlach. * #11981: Improve rendering of signatures using slice syntax, e.g., def foo(arg: np.float64[:,:]) -> None: .... * The manpage builder now adds OSC 8 anchors to hyperlinks, using the groff device control command. * #11015: Change the text of the :rst:dir:`versionadded` directive from New in [...] to Added in [...]. Patch by Bénédikt Tran. * #12131: Added :confval:`show_warning_types` configuration option. Patch by Chris Sewell. * #12193: Improve external warnings for unknown roles. In particular, suggest related role names if an object type is mistakenly used. Patch by Chris Sewell. * Add public type alias :class:`sphinx.util.typing.ExtensionMetadata`. This can be used by extension developers to annotate the return type of their setup function. Patch by Chris Sewell. * #11668: Raise a useful error when theme.conf is missing. Patch by Vinay Sajip. * #11622: Ensure that the order of keys in searchindex.js is deterministic. Patch by Pietro Albini. * #11617: ANSI control sequences are stripped from the output when writing to a warnings file with :option:`-w `. Patch by Bénédikt Tran. * #11666: Skip all hidden directories in CatalogRepository.pofiles. Patch by Aryaz Eghbali. * #9686: html builder: Fix MathJax lazy loading when equations appear in titles. Patch by Bénédikt Tran. * #11483: singlehtml builder: Fix MathJax lazy loading when the index does not contain any math equations. Patch by Bénédikt Tran. * #11697: HTML Search: add \'noindex\' meta robots tag. Patch by James Addison. * #11678: Fix a possible ZeroDivisionError in sphinx.ext.coverage. Patch by Stephen Finucane. * #11756: LaTeX: build error with recent TeXLive due to missing substitutefont package (triggered if using fontenc with T2A option and document language is not a Cyrillic one). Patch by Jean-François B. * #11675: Fix rendering of progression bars in environments that do not support ANSI control sequences. Patch by Bénédikt Tran. * #11861: Whitelist more types with an incorrect __module__ attribute. Patch by Adam Turner. * #11715: Apply tls_verify and tls_cacerts config to ImageDownloader. Patch by Nick Touran. * Allow hyphens in group names for :rst:dir:`productionlist` cross-references. Patch by Adam Turner. * #11433: Added the :confval:`linkcheck_allow_unauthorized` configuration option. Set this option to False to report HTTP 401 (unauthorized) server responses as broken. Patch by James Addison. * #11868: linkcheck: added a distinct timeout reporting status code. This can be enabled by setting :confval:`linkcheck_report_timeouts_as_broken` to False. Patch by James Addison. * #11869: Refresh the documentation for the linkcheck_timeout setting. Patch by James Addison. * #11874: Configure a default 30-second value for linkcheck_timeout. Patch by James Addison. * #11886: Print the Jinja2 template path chain in TemplateNotFound exceptions. Patch by Colin Marquardt. * #11598: Do not use query components in URLs for assets in EPUB rendering. Patch by David Runge. * #11904: Support unary subtraction when parsing annotations. Patch by James Addison. * #11925: Blacklist the sphinxprettysearchresults extension; the functionality it provides was merged into Sphinx v2.0.0. Patch by James Addison. * #11917: Fix rendering of annotated inherited members for Python 3.9. Patch by Janet Carson. * #11935: C Domain: Fix namespace-pop context. Patch by Frank Dana. * #11923: Avoid zombie processes when parallel builds fail. Patch by Felix von Drigalski. * #11353: Support enumeration classes inheriting from mixin or data types. Patch by Bénédikt Tran. * #11962: Fix target resolution when using :paramtype: fields. Patch by Bénédikt Tran. * #11944: Use anchor in search preview. Patch by Will Lachance. * #12008: Fix case-sensitive lookup of std:label names in intersphinx inventory. Patch by Michael Goerz. * #11958: HTML Search: Fix partial matches overwriting full matches. Patch by William Lachance. * #11959: Fix multiple term matching when word appears in both title and document. Patch by Will Lachance. * #11474: Fix doctrees caching causing files not be rebuilt in some cases, e.g., when :confval:`numfig` is True. Patch by Bénédikt Tran. * #11278: autodoc: Fix rendering of :class:`functools.singledispatchmethod` combined with :func:`AATTclassmethod `. Patch by Bénédikt Tran. * #11894: Do not add checksums to css files if building using the htmlhelp builder. Patch by reduerK akiM. * #12052: Remove {{ 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. * #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. * #10984: LaTeX: Document :confval:`latex_additional_files` behavior for files with ``.tex`` extension. * Sun Oct 16 2022 Martin Liška - Update to version 5.3.0 * #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 * Sun Oct 02 2022 Markéta Machová - BuildRequires just flit-core instead of flit * Fri Sep 30 2022 Martin Liška - Update to version 5.2.3 * #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 * Tue Sep 27 2022 Martin Liška - Update to version 5.2.2 * #10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster. * Mon Sep 26 2022 Martin Liška - Update to version 5.2.1 * #10861: Always normalise the ``pycon3`` lexer to ``pycon``. * Fix using ``sphinx.ext.autosummary`` with modules containing titles in the module-level docstring.- Remove unneeded spec hunks. * Sun Sep 25 2022 Martin Liška - Update to version 5.2.0 * #10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA’s build project as a build backend. Patch by Adam Turner. * #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 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 index directive index entries in the search index and search results. Patch by Adam Turner * #10816: imgmath: Allow embedding images in HTML as base64 * #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 * Wed Jul 27 2022 Martin Liška - Update to version 5.1.1 * #10701: Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean`` iterator implementation. * #10702: Restore compatability with third-party builders. * Sun Jul 24 2022 Martin Liška - Update to version 5.1.0 * #10656: Support `Docutils 0.19`_. Patch by Adam Turner. * #10467: Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``. Patch by Adam Turner. * #9856: Deprecated ``sphinx.ext.napoleon.iterators``. * #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 ``
