RPM Search

Changelog for python310-Sphinx-8.0.2-346.1.noarch.rpm :

* 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 ``

`` element when using Docutils 0.18 or later, to allow for easier styling. This matches the behaviour introduced in Docutils 0.19. Patch by Adam Turner.
* #10518: config: Add ``include_patterns`` as the opposite of ``exclude_patterns``. Patch by Adam Turner.
* #10594: HTML Theme: field term colons are doubled if using Docutils 0.18+
* #10596: Build failure if Docutils version is 0.18 (not 0.18.1) due to missing ``Node.findall()``
* #10506: LaTeX: build error if highlighting inline code role in figure caption (refs: #10251)
* #10634: Make -P (pdb) option work better with exceptions triggered from events
* #10031: py domain: Fix spurious whitespace in unparsing various operators (``+``, ``-``, ``~``, and ``
*
*``). Patch by Adam Turner.
* #10460: logging: Always show node source locations as absolute paths.
* HTML Search: HTML tags are displayed as a part of object name
* HTML Search: search snipets should not be folded
* HTML Search: Minor errors are emitted on fetching search snipets
* HTML Search: The markers for header links are shown in the search result
* #10520: HTML Theme: Fix use of sidebar classes in ``agogo.css_t``.
* #6679: HTML Theme: Fix inclusion of hidden toctrees in the agogo theme.
* #10566: HTML Theme: Fix enable_search_shortcuts does not work
* #8686: LaTeX: Text can fall out of code-block at end of page and leave artifact on next page
* #10633: LaTeX: user injected ``\\color`` commands in topic or admonition boxes may cause color leaks in PDF due to upstream `framed.sty `_ bug
* #10638: LaTeX: framed coloured boxes in highlighted code (e.g. highlighted diffs using Pygments style ``\'manni\'``) inherit thickness of code-block frame
* #10647: LaTeX: Only one ``\\label`` is generated for ``desc_signature`` node even if it has multiple node IDs
* #10579: i18n: UnboundLocalError is raised on translating raw directive
* #9577, #10088: py domain: Fix warning for duplicate Python references when using ``:any:`` and autodoc.
* #10548: HTML Search: fix minor summary issues.- Add update-intersphinx.sh and get all objects.inv files.- Add Adam Turner\'s GPG key (61F0FB52) to python-Sphinx.keyring.
* Tue Jul 19 2022 Matej Cepl - (bsc#1201272) Add a missing dependency of latex subpackage on tex(tgtermes.sty).- Add python-Sphinx.keyring
* Fri Jun 17 2022 Martin Liška - Update to version 5.0.2
* #10523: HTML Theme: Expose the Docutils\'s version info tuple as a template variable, ``docutils_version_info``. Patch by Adam Turner.
* #10538: autodoc: Inherited class attribute having docstring is documented even if :confval:`autodoc_inherit_docstring` is disabled
* #10509: autosummary: autosummary fails with a shared library
* #10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.
* #10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+. Patch by Adam Turner.
* #10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.
* Fri Jun 03 2022 Michael Ströder - Update to version 5.0.1
* #10498: gettext: TypeError is raised when sorting warning messages if a node has no line number
* #10493: html theme: :rst:dir:`topic` directive is rendered incorrectly with docutils-0.18
* #10495: IndexError is raised for a :rst:role:`kbd` role having a separator
* Mon May 30 2022 Martin Liška - Update to version 5.0.0:
* #10164: Support `Docutils 0.18`_. Patch by Adam Turner.
* #10031: autosummary: ``sphinx.ext.autosummary.import_by_name()`` now raises ``ImportExceptionGroup`` instead of ``ImportError`` when it failed to import target object. Please handle the exception if your extension uses the function to import Python object. As a workaround, you can disable the behavior via ``grouped_exception=False`` keyword argument until v7.0.
* #9962: texinfo: Customizing styles of emphasized text via ``AATTdefinfoenclose`` command was not supported because the command was deprecated since texinfo 6.8
* #2068: :confval:`intersphinx_disabled_reftypes` has changed default value from an empty list to ``[\'std:doc\']`` as avoid too surprising silent intersphinx resolutions. To migrate: either add an explicit inventory name to the references intersphinx should resolve, or explicitly set the value of this configuration variable to an empty list.
* #10197: html theme: Reduce ``body_min_width`` setting in basic theme to 360px
* #9999: LaTeX: separate terms from their definitions by a CR (refs: #9985)
* #10062: Change the default language to ``\'en\'`` if any language is not set in ``conf.py``
* #10474: :confval:`language` does not accept ``None`` as it value. The default value of ``language`` becomes to ``\'en\'`` now.
* #10028: jQuery and underscore.js will 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 or use the mitigation below. 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``: .. _the Sphinx repository: https://github.com/sphinx-doc/sphinx/tree/v4.3.2/sphinx/themes/basic/static .. code-block:: html+jinja {%- block scripts %} {{ super() }} {%- endblock %}
* setuptools integration. The ``build_sphinx`` sub-command for setup.py is marked as deprecated to follow the policy of setuptools team.
* The ``locale`` argument of ``sphinx.util.i18n:babel_format_date()`` becomes required
* The ``language`` argument of ``sphinx.util.i18n:format_date()`` becomes required
* ``sphinx.builders.html.html5_ready``
* ``sphinx.io.read_doc()``
* ``sphinx.util.docutils.__version_info__``
* ``sphinx.util.docutils.is_html5_writer_available()``
* ``sphinx.writers.latex.LaTeXWriter.docclasses``
* #9075: autodoc: The default value of :confval:`autodoc_typehints_format` is changed to ``\'smart\'``. It will suppress the leading module names of typehints (ex. ``io.StringIO`` -> ``StringIO``).
* #8417: autodoc: ``:inherited-members:`` option now takes multiple classes. It allows to suppress inherited members of several classes on the module at once by specifying the option to :rst:dir:`automodule` directive
* #9792: autodoc: Add new option for ``autodoc_typehints_description_target`` to include undocumented return values but not undocumented parameters.
* #10285: autodoc: singledispatch functions having typehints are not documented
* autodoc: :confval:`autodoc_typehints_format` now also applies to attributes, data, properties, and type variable bounds.
* #10258: autosummary: Recognize a documented attribute of a module as non-imported
* #10028: Removed internal usages of JavaScript frameworks (jQuery and underscore.js) and modernised ``doctools.js`` and ``searchtools.js`` to EMCAScript 2018.
* #10302: C++, add support for conditional expressions (``?:``).
* #5157, #10251: Inline code is able to be highlighted via :rst:dir:`role` directive
* #10337: Make sphinx-build faster by caching Publisher object during build
* #10200: apidoc: Duplicated submodules are shown for modules having both .pyx and .so files
* #10279: autodoc: Default values for keyword only arguments in overloaded functions are rendered as a string literal
* #10280: autodoc: :confval:`autodoc_docstring_signature` unexpectedly generates return value typehint for constructors if docstring has multiple signatures
* #10266: autodoc: :confval:`autodoc_preserve_defaults` does not work for mixture of keyword only arguments with/without defaults
* #10310: autodoc: class methods are not documented when decorated with mocked function
* #10305: autodoc: Failed to extract optional forward-ref\'ed typehints correctly via :confval:`autodoc_type_aliases`
* #10421: autodoc: :confval:`autodoc_preserve_defaults` doesn\'t work on class methods
* #10214: html: invalid language tag was generated if :confval:`language` contains a country code (ex. zh_CN)
* #9974: html: Updated jQuery version from 3.5.1 to 3.6.0
* #10236: html search: objects are duplicated in search result
* #9962: texinfo: Deprecation message for ``AATTdefinfoenclose`` command on bulding texinfo document
* #10000: LaTeX: glossary terms with common definition are rendered with too much vertical whitespace
* #10188: LaTeX: alternating multiply referred footnotes produce a ``?`` in pdf output
* #10363: LaTeX: make ``\'howto\'`` title page rule use ``\\linewidth`` for compatibility with usage of a ``twocolumn`` class option
* #10318: ``:prepend:`` option of :rst:dir:`literalinclude` directive does not work with ``:dedent:`` option
* #9575: autodoc: The annotation of return value should not be shown when ``autodoc_typehints=\"description\"``
* #9648: autodoc: ``
*args`` and ``
*
*kwargs`` entries are duplicated when ``autodoc_typehints=\"description\"``
* #8180: autodoc: Docstring metadata ignored for attributes
* #10443: epub: EPUB builder can\'t detect the mimetype of .webp file
* #10104: gettext: Duplicated locations are shown if 3rd party extension does not provide correct information
* #10456: py domain: ``:meta:`` fields are displayed if docstring contains two or more meta-field
* #9096: sphinx-build: the value of progress bar for paralle build is wrong
* #10110: sphinx-build: exit code is not changed when error is raised on builder-finished event
* Mon Mar 28 2022 Martin Liška - Update to version 4.5.0:
* #10112: extlinks: Disable hardcoded links detector by default
* #9993, #10177: std domain: Disallow to refer an inline target via :rst:role:`ref` role
* ``sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()``
* #10260: Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring
* #10234: autosummary: Add \"autosummary\" CSS class to summary tables
* #10125: extlinks: Improve suggestion message for a reference having title
* #10112: extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable hardcoded links detector feature
* #9494, #9456: html search: Add a config variable :confval:`html_show_search_summary` to enable/disable the search summaries
* #9337: HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:\'/\' as a Quick search shortcut and :kbd:`Esc` shortcut that removes search highlighting.
* #10107: i18n: Allow to suppress translation warnings by adding ``#noqa`` comment to the tail of each translation message
* #10252: C++, support attributes on classes, unions, and enums.
* #10253: :rst:dir:`pep` role now generates URLs based on peps.python.org
* #9876: autodoc: Failed to document an imported class that is built from native binary module
* #10133: autodoc: Crashed when mocked module is used for type annotation
* #10146: autodoc: :confval:`autodoc_default_options` does not support ``no-value`` option
* #9971: autodoc: TypeError is raised when the target object is annotated by unhashable object
* #10205: extlinks: Failed to compile regexp on checking hardcoded links
* #10277: html search: Could not search short words (ex. \"use\")
* #9529: LaTeX: named auto numbered footnote (ex. ``[#named]``) that is referred multiple times was rendered to a question mark
* #9924: LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical spacing in Latexpdf
* #10158: LaTeX: excessive whitespace since v4.4.0 for undocumented variables/structure members
* #10175: LaTeX: named footnote reference is linked to an incorrect footnote if the name is also used in the different document
* #10269: manpage: Failed to resolve the title of :ref: cross references
* #10179: i18n: suppress \"rST localization\" warning
* #10118: imgconverter: Unnecessary availablity check is called for remote URIs
* #10181: napoleon: attributes are displayed like class attributes for google style docstrings when :confval:`napoleon_use_ivar` is enabled
* #10122: sphinx-build: make.bat does not check the installation of sphinx-build command before showing help- Update url for requests.inv.
* Fri Jan 28 2022 Matej Cepl - SPEC cleanup
* Thu Jan 20 2022 Ben Greiner - Fix missing install_requires dependencies.
* Wed Jan 19 2022 Matej Cepl - I know it looks cool to have URLs for all Source files, but these are files in VCS and they are inherently very unstable, so it breaks our checks.
* Sun Jan 16 2022 Martin Liška - Update to version 4.4.0:
* #10007: Use ``importlib_metadata`` for python-3.9 or older
* #10007: Drop ``setuptools``
* #9075: autodoc: Add a config variable :confval:`autodoc_typehints_format` to suppress the leading module names of typehints of function signatures (ex. ``io.StringIO`` -> ``StringIO``)
* #9831: Autosummary now documents only the members specified in a module\'s ``__all__`` attribute if :confval:`autosummary_ignore_module_all` is set to ``False``. The default behaviour is unchanged. Autogen also now supports this behavior with the ``--respect-module-all`` switch.
* #9555: autosummary: Improve error messages on failure to load target object
* #9800: extlinks: Emit warning if a hardcoded link is replaceable by an extlink, suggesting a replacement.
* #9961: html: Support nested HTML elements in other HTML builders * #10013: html: Allow to change the loading method of JS via ``loading_method`` parameter for :meth:`Sphinx.add_js_file()` * #9551: html search: \"Hide Search Matches\" link removes \"highlight\" parameter from URL * #9815: html theme: Wrap sidebar components in div to allow customizing their layout via CSS * #9827: i18n: Sort items in glossary by translated terms * #9899: py domain: Allows to specify cross-reference specifier (``.`` and ``~``) as ``:type:`` option * #9894: linkcheck: add option ``linkcheck_exclude_documents`` to disable link checking in matched documents. * #9793: sphinx-build: Allow to use the parallel build feature in macOS on macOS and Python3.8+ * #10055: sphinx-build: Create directories when ``-w`` option given * #9993: std domain: Allow to refer an inline target (ex. ``_`target name```) via :rst:role:`ref` role * #9981: std domain: Strip value part of the option directive from general index * #9391: texinfo: improve variable in ``samp`` role * #9578: texinfo: Add :confval:`texinfo_cross_references` to disable cross references for readability with standalone readers * #9822 (and #9062), add new Intersphinx role :rst:role:`external` for explict lookup in the external projects, without resolving to the local project. * #9866: autodoc: doccomment for the imported class was ignored * #9883: autodoc: doccomment for the alias to mocked object was ignored * #9908: autodoc: debug message is shown on building document using NewTypes with Python 3.10 * #9968: autodoc: instance variables are not shown if __init__ method has position-only-arguments * #9194: autodoc: types under the \"typing\" module are not hyperlinked * #10009: autodoc: Crashes if target object raises an error on getting docstring * #10058: autosummary: Imported members are not shown when ``autodoc_class_signature = \'separated\'`` * #9947: i18n: topic directive having a bullet list can\'t be translatable * #9878: mathjax: MathJax configuration is placed after loading MathJax itself * #9932: napoleon: empty \"returns\" section is generated even if no description * #9857: Generated RFC links use outdated base url * #9909: HTML, prevent line-wrapping in literal text. * #10061: html theme: Configuration values added by themes are not be able to override from conf.py * #10073: imgconverter: Unnecessary availablity check is called for \"data\" URIs * #9925: LaTeX: prohibit also with ``\'xelatex\'`` line splitting at dashes of inline and parsed literals * #9944: LaTeX: extra vertical whitespace for some nested declarations * #9940: LaTeX: Multi-function declaration in Python domain has cramped vertical spacing in latexpdf output * #10015: py domain: types under the \"typing\" module are not hyperlinked defined at info-field-list * #9390: texinfo: Do not emit labels inside footnotes * #9413: xml: Invalid XML was generated when cross referencing python objects * #9979: Error level messages were displayed as warning messages * #10057: Failed to scan documents if the project is placed onto the root directory * #9636: code-block: ``:dedent:`` without argument did strip newlines- Add new intersphinx mapping file: readthedocs.inv.- Fix %fdupes.- Remove python-Sphinx-rpmlintrc as it is not used any more. * Wed Dec 22 2021 Martin Liška - Update to version 4.3.2: * #9917: C and C++, parse fundamental types no matter the order of simple type specifiers. * Sat Nov 27 2021 Arun Persaud - update to version 4.3.1: * Features added + #9864: mathjax: Support chnaging the loading method of MathJax to \"defer\" via :confval:`mathjax_options` * Bugs fixed + #9838: autodoc: AttributeError is raised on building document for functions decorated by functools.lru_cache + #9879: autodoc: AttributeError is raised on building document for an object having invalid __doc__ atribute + #9844: autodoc: Failed to process a function wrapped with functools.partial if :confval:`autodoc_preserve_defaults` enabled + #9872: html: Class namespace collision between autodoc signatures and docutils-0.17 + #9868: imgmath: Crashed if the dvisvgm command failed to convert equation + #9864: mathjax: Failed to render equations via MathJax v2. The loading method of MathJax is back to \"async\" method again * Fri Nov 12 2021 Matej Cepl - Explicitly Require python-sphinxcontrib-qthelp >= 1.0.2 to prevent bsc#1157793 and bsc#1158158 from occuring. * Fri Nov 12 2021 Martin Liška - Update rpmlintrc file.- Update to 4.3.0: * Support Python 3.10 * #9649: ``searchindex.js``: the embedded data has changed format to allow objects with the same name in different domains. * #9672: The rendering of Python domain declarations is implemented with more docutils nodes to allow better CSS styling. It may break existing styling. * #9672: the signature of :py:meth:`domains.py.PyObject.get_signature_prefix` has changed to return a list of nodes instead of a plain string. * #9695: ``domains.js.JSObject.display_prefix`` has been changed into a method ``get_display_prefix`` which now returns a list of nodes instead of a plain string. * #9695: The rendering of Javascript domain declarations is implemented with more docutils nodes to allow better CSS styling. It may break existing styling. * #9450: mathjax: Load MathJax via \"defer\" strategy * ``sphinx.ext.autodoc.AttributeDocumenter._datadescriptor`` * ``sphinx.writers.html.HTMLTranslator._fieldlist_row_index`` * ``sphinx.writers.html.HTMLTranslator._table_row_index`` * ``sphinx.writers.html5.HTML5Translator._fieldlist_row_index`` * ``sphinx.writers.html5.HTML5Translator._table_row_index`` * #9639: autodoc: Support asynchronous generator functions * #9664: autodoc: ``autodoc-process-bases`` supports to inject reST snippet as a base class * #9691: C, added new info-field ``retval`` for :rst:dir:`c:function` and :rst:dir:`c:macro`. * C++, added new info-field ``retval`` for :rst:dir:`cpp:function`. * #9618: i18n: Add :confval:`gettext_allow_fuzzy_translations` to allow \"fuzzy\" messages for translation * #9672: More CSS classes on Python domain descriptions * #9695: More CSS classes on Javascript domain descriptions * #9683: Revert the removal of ``add_stylesheet()`` API. It will be kept until the Sphinx-6.0 release * #2068, add :confval:`intersphinx_disabled_reftypes` for disabling interphinx resolution of cross-references that do not have an explicit inventory specification. Specific types of cross-references can be disabled, e.g., ``std:doc`` or all cross-references in a specific domain, e.g., ``std: *``. * #9623: Allow to suppress \"toctree contains reference to excluded document\" warnings using :confval:`suppress_warnings` * #9630: autodoc: Failed to build cross references if :confval:`primary_domain` is not \'py\' * #9644: autodoc: Crashed on getting source info from problematic object * #9655: autodoc: mocked object having doc comment is warned unexpectedly * #9651: autodoc: return type field is not generated even if :confval:`autodoc_typehints_description_target` is set to \"documented\" when its info-field-list contains ``:returns:`` field * #9657: autodoc: The base class for a subclass of mocked object is incorrect * #9607: autodoc: Incorrect base class detection for the subclasses of the generic class * #9755: autodoc: memory addresses are shown for aliases * #9752: autodoc: Failed to detect type annotation for slots attribute * #9756: autodoc: Crashed if classmethod does not have __func__ attribute * #9757: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to overriden classmethods * #9781: autodoc: :confval:`autodoc_preserve_defaults` does not support hexadecimal numeric * #9630: autosummary: Failed to build summary table if :confval:`primary_domain` is not \'py\' * #9670: html: Fix download file with special characters * #9710: html: Wrong styles for even/odd rows in nested tables * #9763: html: parameter name and its type annotation are not separated in HTML * #9649: HTML search: when objects have the same name but in different domains, return all of them as result instead of just one. * #7634: intersphinx: references on the file in sub directory are broken * #9737: LaTeX: hlist is rendered as a list containing \"aggedright\" text * #9678: linkcheck: file extension was shown twice in warnings * #9697: py domain: An index entry with parens was registered for ``py:method`` directive with ``:property:`` option * #9775: py domain: Literal typehint was converted to a cross reference when :confval:`autodoc_typehints=\'description\'` * #9708: needs_extension failed to check double-digit version correctly * #9688: Fix :rst:dir:`code`` does not recognize ``:class:`` option * #9733: Fix for logging handler flushing warnings in the middle of the docs build * #9656: Fix warnings without subtype being incorrectly suppressed * Intersphinx, for unresolved references with an explicit inventory, e.g., ``proj:myFunc``, leave the inventory prefix in the unresolved text. * Wed Nov 10 2021 Matej Cepl - Fix Provides and Obsoletes ... we cannot use python_module there * Tue Sep 14 2021 Martin Liška - Update to 4.2.0: * #9445: autodoc: Support class properties * #9479: autodoc: Emit a warning if target is a mocked object * #9560: autodoc: Allow to refer NewType instances with module name in Python 3.10 or above * #9447: html theme: Expose the version of Sphinx in the form of tuple as a template variable ``sphinx_version_tuple`` * #9594: manpage: Suppress the title of man page if description is empty * #9445: py domain: ``:py:property:`` directive supports ``:classmethod:`` option to describe the class property * #9524: test: SphinxTestApp can take ``builddir`` as an argument * #9535: C and C++, support more fundamental types, including GNU extensions. * #9608: apidoc: apidoc does not generate a module definition for implicit namespace package * #9504: autodoc: generate incorrect reference to the parent class if the target class inherites the class having ``_name`` attribute * #9537, #9589: autodoc: Some objects under ``typing`` module are not displayed well with the HEAD of 3.10 * #9487: autodoc: typehint for cached_property is not shown * #9509: autodoc: AttributeError is raised on failed resolving typehints * #9518: autodoc: autodoc_docstring_signature does not effect to ``__init__()`` and ``__new__()`` * #9522: autodoc: PEP 585 style typehints having arguments (ex. ``list[int]``) are not displayed well * #9481: autosummary: some warnings contain non-existing filenames * #9568: autosummary: summarise overlined sectioned headings correctly * #9600: autosummary: Type annotations which contain commas in autosummary table are not removed completely * #9481: c domain: some warnings contain non-existing filenames * #9481: cpp domain: some warnings contain non-existing filenames * #9456: html search: abbreation marks are inserted to the search result if failed to fetch the content of the page * #9617: html search: The JS requirement warning is shown if browser is slow * #9267: html theme: CSS and JS files added by theme were loaded twice * #9585: py domain: ``:type:`` option for :rst:dir:`py:property` directive does not create a hyperlink * #9576: py domain: Literal typehint was converted to a cross reference * #9535 comment: C++, fix parsing of defaulted function parameters that are function pointers. * #9564: smartquotes: don\'t adjust typography for text with language-highlighted ``:code:`` role. * #9512: sphinx-build: crashed with the HEAD of Python 3.10 * Sun Aug 01 2021 Dirk Müller - update to 4.1.2: * linkcheck: Disable checking automatically generated anchors on github.com (ex. anchors in reST/Markdown documents) * autodoc: Custom types using ``typing.NewType`` are not displayed well with the HEAD of 3.10 * autodoc: Some objects under ``typing`` module are not displayed well with the HEAD of 3.10 * autodoc: crashed if ``autodoc_class_signature = \"separated\"`` * html search: html_copy_source can\'t control the search summaries * linkcheck: Failed to check anchors in github.com * Sat Jul 17 2021 Dirk Müller - update to 4.1.1: * sphinxcontrib-htmlhelp-2.0.0 or above * sphinxcontrib-serializinghtml-1.1.5 or above * html: HTML logo or Favicon specified as file not being found on output * Mon Jul 12 2021 Martin Liška - Bump to 4.1.0: * Support jinja2-3.0 * The ``app`` argument of ``sphinx.environment.BuildEnvironment`` becomes required * ``sphinx.application.Sphinx.html_theme`` * ``sphinx.ext.autosummary._app`` * ``sphinx.util.docstrings.extract_metadata()`` * #8107: autodoc: Add ``class-doc-from`` option to :rst:dir:`autoclass` directive to control the content of the specific class like :confval:`autoclass_content` * #8588: autodoc: :confval:`autodoc_type_aliases` now supports dotted name. It allows you to define an alias for a class with module name like ``foo.bar.BazClass`` * #9175: autodoc: Special member is not documented in the module * #9195: autodoc: The arguments of ``typing.Literal`` are wrongly rendered * #9185: autodoc: :confval:`autodoc_typehints` allows ``\'both\'`` setting to allow typehints to be included both in the signature and description * #4257: autodoc: Add :confval:`autodoc_class_signature` to separate the class entry and the definition of ``__init__()`` method * #8061, #9218: autodoc: Support variable comment for alias classes * #3014: autodoc: Add :event:`autodoc-process-bases` to modify the base classes of the class definitions * #9272: autodoc: Render enum values for the default argument value better * #9384: autodoc: ``autodoc_typehints=\'none\'`` now erases typehints for variables, attributes and properties * #3257: autosummary: Support instance attributes for classes * #9358: html: Add \"heading\" role to the toctree items * #9225: html: Add span tag to the return typehint of method/function * #9129: html search: Show search summaries when html_copy_source = False * #9307: html search: Prevent corrections and completions in search field * #9120: html theme: Eliminate prompt characters of code-block from copyable text * #9176: i18n: Emit a debug message if message catalog file not found under :confval:`locale_dirs` * #9414: LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents * #9016: linkcheck: Support checking anchors on github.com * #9016: linkcheck: Add a new event :event:`linkcheck-process-uri` to modify URIs before checking hyperlinks * #6525: linkcheck: Add :confval:`linkcheck_allowed_redirects` to mark hyperlinks that are redirected to expected URLs as \"working\" * #1874: py domain: Support union types using ``|`` in info-field-list * #9268: py domain: :confval:`python_use_unqualified_type_names` supports type field in info-field-list * #9097: Optimize the parallel build * #9131: Add :confval:`nitpick_ignore_regex` to ignore nitpicky warnings using regular expressions * #9174: Add ``Sphinx.set_html_assets_policy`` to tell extensions to include HTML assets in all the pages. Extensions can check this via ``Sphinx.registry.html_assets_policy`` * C++, add support for - ``inline`` variables, - ``consteval`` functions, - ``constinit`` variables, - ``char8_t``, - ``explicit()`` specifier, - digit separators in literals, and - constraints in placeholder type specifiers, aka. adjective syntax (e.g., ``Sortable auto &v``). * C, add support for digit separators in literals. * #9166: LaTeX: support containers in LaTeX output * #8872: autodoc: stacked singledispatches are wrongly rendered * #8597: autodoc: a docsting having metadata only should be treated as undocumented * #9185: autodoc: typehints for overloaded functions and methods are inaccurate * #9250: autodoc: The inherited method not having docstring is wrongly parsed * #9283: autodoc: autoattribute directive failed to generate document for an attribute not having any comment * #9364: autodoc: single element tuple on the default argument value is wrongly rendered * #9362: autodoc: AttributeError is raised on processing a subclass of Tuple[()] * #9404: autodoc: TypeError is raised on processing dict-like object (not a class) via autoclass directive * #9317: html: Pushing left key causes visiting the next page at the first page * #9381: html: URL for html_favicon and html_log does not work * #9270: html theme : pyramid theme generates incorrect logo links * #9217: manpage: The name of manpage directory that is generated by :confval:`man_make_section_directory` is not correct * #9350: manpage: Fix font isn\'t reset after keyword at the top of samp role * #9306: Linkcheck reports broken link when remote server closes the connection on HEAD request * #9280: py domain: \"exceptions\" module is not displayed * #9418: py domain: a Callable annotation with no parameters (e.g. ``Callable[[], None])`` will be rendered with a bracket missing (``Callable[], None]``) * #9319: quickstart: Make sphinx-quickstart exit when conf.py already exists * #9387: xml: XML Builder ignores custom visitors * #9224: ``:param:`` and ``:type:`` fields does not support a type containing whitespace (ex. ``Dict[str, str]``) * #8945: when transforming typed fields, call the specified role instead of making an single xref. For C and C++, use the ``expr`` role for typed fields. * Sat Jun 05 2021 Martin Liška - Update again to 4.0.2. * Wed Jun 02 2021 Matej Cepl - Switch off the failing test_signature_annotations. It is just not worthy filing upstream test on the obsolete version. * Wed Jun 02 2021 Matej Cepl - Revert to 3.5.4 * Fri May 21 2021 Martin Liška - Update to 4.0.2: see upstream CHANGES.- Add texlive-tex-gyre build dependency for tests. * Fri Apr 16 2021 Dirk Müller - update to 3.5.4: * #9071: Restrict docutils to 0.16 * #9078: autodoc: Async staticmethods and classmethods are considered as non async coroutine-functions with Python3.10 * #8870, #9001, #9051: html theme: The style are not applied with docutils-0.17 * Tue Apr 06 2021 Dirk Müller - update to 3.5.3: * #8959: using UNIX path separator in image directive confuses Sphinx on Windows * Tue Mar 16 2021 Dirk Müller - update to 3.5.2: * #8943: i18n: Crashed by broken translation messages in ES, EL and HR * #8936: LaTeX: A custom LaTeX builder fails with unknown node error * #8952: Exceptions raised in a Directive cause parallel builds to hang * #8883: autodoc: AttributeError is raised on assigning __annotations__ on read-only class * #8884: html: minified js stemmers not included in the distributed package * #8885: html: AttributeError is raised if CSS/JS files are installed via :confval:`html_context` * #8880: viewcode: ExtensionError is raised on incremental build after unparsable python module found * LaTeX: ``multicol`` (it is anyhow a required part of the official latex2e base distribution) * Update Underscore.js to 1.12.0 * #6550: html: The config variable ``html_add_permalinks`` is replaced by :confval:`html_permalinks` and :confval:`html_permalinks_icon` * pending_xref node for viewcode extension * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore`` * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth`` * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken`` * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.good`` * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected`` * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue`` * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore`` * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers`` * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue`` * ``sphinx.builders.linkcheck.node_line_or_0()`` * ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()`` * ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter`` * ``sphinx.ext.autodoc.importer.get_module_members()`` * ``sphinx.ext.autosummary.generate._simple_info()`` * ``sphinx.ext.autosummary.generate._simple_warn()`` * ``sphinx.writers.html.HTMLTranslator.permalink_text`` * ``sphinx.writers.html5.HTML5Translator.permalink_text`` * #8022: autodoc: autodata and autoattribute directives does not show right-hand value of the variable if docstring contains ``:meta hide-value:`` in info-field-list * #8514: autodoc: Default values of overloaded functions are taken from actual implementation if they\'re ellipsis * #8775: autodoc: Support type union operator (PEP-604) in Python 3.10 or above * #8297: autodoc: Allow to extend :confval:`autodoc_default_options` via directive options * #8619: html: kbd role generates customizable HTML tags for compound keys * #8634: html: Allow to change the order of JS/CSS via ``priority`` parameter for :meth:`Sphinx.add_js_file()` and :meth:`Sphinx.add_css_file()` * #6241: html: Allow to add JS/CSS files to the specific page when an extension calls ``app.add_js_file()`` or ``app.add_css_file()`` on :event:`html-page-context` event * #6550: html: Allow to use HTML permalink texts via :confval:`html_permalinks_icon` * #1638: html: Add permalink icons to glossary terms * #8868: html search: performance issue with massive lists * #8867: html search: Update JavaScript stemmer code to the latest version of Snowball (v2.1.0) * #8852: i18n: Allow to translate heading syntax in MyST-Parser * #8649: imgconverter: Skip availability check if builder supports the image type * #8573: napoleon: Allow to change the style of custom sections using :confval:`napoleon_custom_styles` * #8004: napoleon: Type definitions in Google style docstrings are rendered as references when :confval:`napoleon_preprocess_types` enabled * #6241: mathjax: Include mathjax.js only on the document using equations * #8775: py domain: Support type union operator (PEP-604) * #8651: std domain: cross-reference for a rubric having inline item is broken * #7642: std domain: Optimize case-insensitive match of term * #8681: viewcode: Support incremental build * #8132: Add :confval:`project_copyright` as an alias of :confval:`copyright` * #207: Now :confval:`highlight_language` supports multiple languages * #2030: :rst:dir:`code-block` and :rst:dir:`literalinclude` supports automatic dedent via no-argument ``:dedent:`` option * C++, also hyperlink operator overloads in expressions and alias declarations. * #8247: Allow production lists to refer to tokens from other production groups * #8813: Show what extension (or module) caused it on errors on event handler * #8213: C++: add ``maxdepth`` option to :rst:dir:`cpp:alias` to insert nested declarations. * C, add ``noroot`` option to :rst:dir:`c:alias` to render only nested declarations. * C++, add ``noroot`` option to :rst:dir:`cpp:alias` to render only nested declarations. * #8727: apidoc: namespace module file is not generated if no submodules there * #741: autodoc: inherited-members doesn\'t work for instance attributes on super class * #8592: autodoc: ``:meta public:`` does not effect to variables * #8594: autodoc: empty __all__ attribute is ignored * #8315: autodoc: Failed to resolve struct.Struct type annotation * #8652: autodoc: All variable comments in the module are ignored if the module contains invalid type comments * #8693: autodoc: Default values for overloaded functions are rendered as string * #8134: autodoc: crashes when mocked decorator takes arguments * #8800: autodoc: Uninitialized attributes in superclass are recognized as undocumented * #8655: autodoc: Failed to generate document if target module contains an object that raises an exception on ``hasattr()`` * #8306: autosummary: mocked modules are documented as empty page when using :recursive: option * #8232: graphviz: Image node is not rendered if graph file is in subdirectory * #8618: html: kbd role produces incorrect HTML when compound-key separators (-, + or ^) are used as keystrokes * #8629: html: A type warning for html_use_opensearch is shown twice * #8714: html: kbd role with \"Caps Lock\" rendered incorrectly * #8123: html search: fix searching for terms containing + (Requires a custom search language that does not split on +) * #8665: html theme: Could not override globaltoc_maxdepth in theme.conf * #8446: html: consecutive spaces are displayed as single space * #8745: i18n: crashes with KeyError when translation message adds a new auto footnote reference * #4304: linkcheck: Fix race condition that could lead to checking the availability of the same URL twice * #8791: linkcheck: The docname for each hyperlink is not displayed * #7118: sphinx-quickstart: questionare got Mojibake if libreadline unavailable * #8094: texinfo: image files on the different directory with document are not copied * #8782: todo: Cross references in todolist get broken * #8720: viewcode: module pages are generated for epub on incremental build * #8704: viewcode: anchors are generated in incremental build after singlehtml * #8756: viewcode: highlighted code is generated even if not referenced * #8671: :confval:`highlight_options` is not working * #8341: C, fix intersphinx lookup types for names in declarations. * C, C++: in general fix intersphinx and role lookup types. * #8683: :confval:`html_last_updated_fmt` does not support UTC offset (%z) * #8683: :confval:`html_last_updated_fmt` generates wrong time zone for %Z * #1112: ``download`` role creates duplicated copies when relative path is specified * #2616 (fifth item): LaTeX: footnotes from captions are not clickable, and for manually numbered footnotes only first one with same number is an hyperlink * #7576: LaTeX with French babel and memoir crash: \"Illegal parameter number in definition of ``\\FNHAATTprefntext``\" * #8055: LaTeX (docs): A potential display bug with the LaTeX generation step in Sphinx (how to generate one-column index) * #8072: LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX * #8214: LaTeX: The :rst:role:`index` role and the glossary generate duplicate entries in the LaTeX index (if both used for same term) * #8735: LaTeX: wrong internal links in pdf to captioned code-blocks when :confval:`numfig` is not True * #8442: LaTeX: some indexed terms are ignored when using xelatex engine (or pdflatex and :confval:`latex_use_xindy` set to True) with memoir class * #8750: LaTeX: URLs as footnotes fail to show in PDF if originating from inside function type signatures * #8780: LaTeX: long words in narrow columns may not be hyphenated * #8788: LaTeX: ``\\titleformat`` last argument in sphinx.sty should be bracketed, not braced (and is anyhow not needed) * #8849: LaTex: code-block printed out of margin (see the opt-in LaTeX syntax boolean :ref:`verbatimforcewraps ` for use via the :ref:`\'sphinxsetup\' ` key of ``latex_elements``) * #8183: LaTeX: Remove substitution_reference nodes from doctree only on LaTeX builds * #8865: LaTeX: Restructure the index nodes inside title nodes only on LaTeX builds * #8796: LaTeX: potentially critical low level TeX coding mistake has gone unnoticed so far * C, :rst:dir:`c:alias` skip symbols without explicit declarations instead of crashing. * C, :rst:dir:`c:alias` give a warning when the root symbol is not declared. * C, ``expr`` role should start symbol lookup in the current scope. * #8655: autodoc: Failed to generate document if target module contains an object that raises an exception on ``hasattr()`` * Wed Jan 13 2021 Markéta Machová - Update to 3.4.3 * Bugfix release, see upstream CHANGES * Mon Jan 11 2021 Markéta Machová - Do not download python (and requests) documentation in the runtime.- Add file requests.inv