Skip to content

chore(deps): update dependency sphinx to v6 - autoclosed

RenovateBot requested to merge renovate/sphinx-6.x into develop

This MR contains the following updates:

Package Type Update Change
Sphinx (changelog) dev-dependencies major ^4.5.0 -> ^6.0.0

Release Notes

sphinx-doc/sphinx

v6.2.1

Compare Source

=====================================

Bugs fixed

  • #​11355: Revert the default type of :confval:nitpick_ignore and :confval:nitpick_ignore_regex to list.

v6.2.0

Compare Source

=====================================

Dependencies

  • Require Docutils 0.18.1 or greater.

Incompatible changes

  • LaTeX: removal of some internal TeX \dimen registers (not previously publicly documented) as per 5.1.0 code comments in sphinx.sty: \sphinxverbatimsep, \sphinxverbatimborder, \sphinxshadowsep, \sphinxshadowsize, and \sphinxshadowrule. (refs: #​11105)
  • Remove .egg support from pycode ModuleAnalyser; Python eggs are a now-obsolete binary distribution format
  • #​11089: Remove deprecated code in sphinx.builders.linkcheck. Patch by Daniel Eades
  • Remove internal-only sphinx.locale.setlocale

Deprecated

  • #​11247: Deprecate the legacy intersphinx_mapping format
  • sphinx.util.osutil.cd is deprecated in favour of contextlib.chdir.

Features added

  • #​11277: :rst:dir:autoproperty allows the return type to be specified as a type comment (e.g., # type: () -> int). Patch by Bénédikt Tran
  • #​10811: Autosummary: extend __all__ to imported members for template rendering when option autosummary_ignore_module_all is set to False. Patch by Clement Pinard
  • #​11147: Add a content_offset parameter to nested_parse_with_titles(), allowing for correct line numbers during nested parsing. Patch by Jeremy Maitin-Shepard
  • Update to Unicode CLDR 42
  • Add a --jobs synonym for -j. Patch by Hugo van Kemenade
  • LaTeX: a command \sphinxbox for styling text elements with a (possibly rounded) box, optional background color and shadow, has been added. See :ref:sphinxbox. (refs: #​11224)
  • LaTeX: add \sphinxstylenotetitle, ..., \sphinxstylewarningtitle, ..., for an extra layer of mark-up freeing up \sphinxstrong for other uses. See :ref:latex-macros. (refs: #​11267)
  • LaTeX: :dudir:note, :dudir:hint, :dudir:important and :dudir:tip can now each be styled as the other admonitions, i.e. possibly with a background color, individual border widths and paddings, possibly rounded corners, and optional shadow. See :ref:additionalcss. (refs: #​11234)
  • LaTeX: admonitions and :dudir:topic (and :dudir:contents <table-of-contents>) directives, and not only :rst:dir:code-block, support box-decoration-break=slice.
  • LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: #​11243)
  • LaTeX: new options noteTextColor, noteTeXextras et al. See :ref:additionalcss.
  • LaTeX: support elliptical corners in rounded boxes. (refs: #​11254)
  • #​11150: Include source location in highlighting warnings, when lexing fails. Patch by Jeremy Maitin-Shepard
  • #​11281: Support for :confval:imgmath_latex = 'tectonic' or = 'xelatex'. Patch by Dimitar Dimitrov
  • #​11109, #​9643: Add :confval:python_display_short_literal_types option for condensed rendering of Literal types.

Bugs fixed

  • #​11079: LaTeX: figures with align attribute may disappear and strangely impact following lists
  • #​11093: LaTeX: fix "multiply-defined references" PDF build warnings when one or more reST labels directly precede an :rst:dir:py:module or :rst:dir:automodule directive. Patch by Bénédikt Tran (picnixz)
  • #​11110: LaTeX: Figures go missing from latex pdf if their files have the same base name and they use a post transform. Patch by aaron-cooper
  • LaTeX: fix potential color leak from shadow to border of rounded boxes, if shadow color is set but border color is not
  • LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames respective to contents (when using rounded corners)
  • #​11235: LaTeX: added \color in topic (or admonition) contents may cause color leak to the shadow and border at a page break
  • #​11264: LaTeX: missing space before colon after "Voir aussi" for :rst:dir:seealso directive in French
  • #​11268: LaTeX: longtable with left alignment breaks out of current list indentation context in PDF. Thanks to picnixz.
  • #​11274: LaTeX: external links are not properly escaped for \sphinxupquote compatibility
  • #​11147: Fix source file/line number info in object description content and in other uses of nested_parse_with_titles. Patch by Jeremy Maitin-Shepard.
  • #​11192: Restore correct parallel search index building. Patch by Jeremy Maitin-Shepard
  • Use the new Transifex tx client

Testing

  • Fail testing when any Python warnings are emitted
  • Migrate remaining unittest.TestCase style test functions to pytest style
  • Remove tests that rely on setuptools

v6.1.3

Compare Source

=====================================

Bugs fixed

  • #​11116: Reverted to previous Sphinx 5 node copying method
  • #​11117: Reverted changes to parallel image processing from Sphinx 6.1.0
  • #​11119: Supress ValueError in the linkcheck builder

v6.1.2

Compare Source

=====================================

Bugs fixed

  • #​11101: LaTeX: div.topic_padding key of sphinxsetup documented at 5.1.0 was implemented with name topic_padding
  • #​11099: LaTeX: shadowrule key of sphinxsetup causes PDF build to crash since Sphinx 5.1.0
  • #​11096: LaTeX: shadowsize key of sphinxsetup causes PDF build to crash since Sphinx 5.1.0
  • #​11095: LaTeX: shadow of :dudir:topic and :dudir:contents <table-of-contents> boxes not in page margin since Sphinx 5.1.0
  • #​11100: Fix copying images when running under parallel mode.

v6.1.1

Compare Source

=====================================

Bugs fixed

  • #​11091: Fix util.nodes.apply_source_workaround for literal_block nodes with no source information in the node or the node's parents.

v6.1.0

Compare Source

=====================================

Dependencies

Incompatible changes

  • #​10979: gettext: Removed support for pluralisation in get_translation. This was unused and complicated other changes to sphinx.locale.

Deprecated

  • sphinx.util functions:

    • Renamed sphinx.util.typing.stringify() to sphinx.util.typing.stringify_annotation()
    • Moved sphinx.util.xmlname_checker() to sphinx.builders.epub3._XML_NAME_PATTERN

    Moved to sphinx.util.display:

    • sphinx.util.status_iterator
    • sphinx.util.display_chunk
    • sphinx.util.SkipProgressMessage
    • sphinx.util.progress_message

    Moved to sphinx.util.http_date:

    • sphinx.util.epoch_to_rfc1123
    • sphinx.util.rfc1123_to_epoch

    Moved to sphinx.util.exceptions:

    • sphinx.util.save_traceback
    • sphinx.util.format_exception_cut_frames

Features added

  • Cache doctrees in the build environment during the writing phase.
  • Make all writing phase tasks support parallel execution.
  • #​11072: Use PEP 604 (X | Y) display conventions for typing.Optional and typing.Optional types within the Python domain and autodoc.
  • #​10700: autodoc: Document typing.NewType() types as classes rather than 'data'.
  • Cache doctrees between the reading and writing phases.

Bugs fixed

  • #​10962: HTML: Fix the multi-word key name lookup table.
  • Fixed support for Python 3.12 alpha 3 (changes in the enum module).
  • #​11069: HTML Theme: Removed outdated "shortcut" link relation keyword.
  • #​10952: Properly terminate parallel processes on programme interuption.
  • #​10988: Speed up TocTree.resolve() through more efficient copying.
  • #​6744: LaTeX: support for seealso directive should be via an environment to allow styling.
  • #​11074: LaTeX: Can't change sphinxnote to use sphinxheavybox starting with 5.1.0

v6.0.1

Compare Source

=====================================

Dependencies

  • Require Pygments 2.13 or later.

Bugs fixed

  • #​10944: imgmath: Fix resolving image paths for files in nested folders.

v6.0.0

Compare Source

=====================================

Dependencies

  • #​10468: Drop Python 3.6 support
  • #​10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner

Incompatible changes

  • #​7405: Removed the jQuery and underscore.js JavaScript frameworks.

    These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the jQuery, $, or $u global objects, you need to update your JavaScript to modern standards, or use the mitigation below.

    The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add sphinxcontrib.jquery to the extensions list in conf.py, or call app.setup_extension("sphinxcontrib.jquery") if you develop a Sphinx theme or extension.

    The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy jquery.js and underscore.js from the Sphinx repository_ to your static directory, and add the following to your layout.html:

    .. code-block:: html+jinja

    {%- block scripts %} {{ super() }} {%- endblock %}

    .. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/

    Patch by Adam Turner.

  • #​10471, #​10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:dev-deprecated-apis for details. Patch by Adam Turner.

  • #​10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables c_allow_pre_v3 and c_warn_on_allowed_pre_v3. Patch by Adam Turner.

Features added

  • #​10924: LaTeX: adopt better looking defaults for tables and code-blocks. See :confval:latex_table_style and the pre_border-radius and pre_background-TeXcolor :ref:additionalcss for the former defaults and how to re-enact them if desired.

Bugs fixed

  • #​10984: LaTeX: Document :confval:latex_additional_files behavior for files with .tex extension.

v5.3.0

Compare Source

=====================================

  • #​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

v5.2.3

Compare Source

=====================================

  • #​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

v5.2.2

Compare Source

=====================================

  • #​10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster.

v5.2.1

Compare Source

=====================================

Bugs fixed

  • #​10861: Always normalise the pycon3 lexer to pycon.
  • Fix using sphinx.ext.autosummary with modules containing titles in the module-level docstring.

v5.2.0

Compare Source

===========================================

  • Recreated source tarballs for Debian maintainers.

v5.1.1

Compare Source

=====================================

Bugs fixed

  • #​10701: Fix ValueError in the new deque based sphinx.ext.napolean iterator implementation.
  • #​10702: Restore compatability with third-party builders.

v5.1.0

Compare Source

=====================================

Dependencies

  • #​10656: Support Docutils 0.19_. Patch by Adam Turner.

.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05

Deprecated

  • #​10467: Deprecated sphinx.util.stemmer in favour of snowballstemmer. Patch by Adam Turner.
  • #​9856: Deprecated sphinx.ext.napoleon.iterators.

Features added

  • #​10444: html theme: Allow specifying multiple CSS files through the stylesheet setting in theme.conf or by setting html_style to an iterable of strings.
  • #​10366: std domain: Add support for emphasising placeholders in :rst:dir:option directives through a new :confval:option_emphasise_placeholders configuration option.
  • #​10439: std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify.
  • #​10571: quickstart: Reduce content in the generated conf.py file. Patch by Pradyun Gedam.
  • #​10648: LaTeX: CSS-named-alike additional :ref:'sphinxsetup' <latexsphinxsetup> 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 <aside> 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.

Bugs fixed

  • #​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
  • #​10550: py domain: Fix spurious whitespace in unparsing various operators (+, -, ~, and **). Patch by Adam Turner (refs: #​10551).
  • #​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 <https://ctan.org/pkg/framed>_ 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.

v5.0.2

Compare Source

=====================================

Features added

  • #​10523: HTML Theme: Expose the Docutils's version info tuple as a template variable, docutils_version_info. Patch by Adam Turner.

Bugs fixed

  • #​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.

v5.0.1

Compare Source

=====================================

Bugs fixed

  • #​10498: gettext: TypeError is raised when sorting warning messages if a node has no line number. Patch by Adam Turner.
  • #​10493: HTML Theme: :dudir:topic directive is rendered incorrectly with Docutils 0.18. Patch by Adam Turner.
  • #​10495: IndexError is raised for a :rst:role:kbd role having a separator. Patch by Adam Turner.

v5.0.0

Compare Source

=====================================

Dependencies

5.0.0 b1

  • #​10164: Support Docutils 0.18_. Patch by Adam Turner.

.. _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26

Incompatible changes

5.0.0 b1

  • #​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 @definfoenclose 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

5.0.0 final

  • #​10474: :confval:language does not accept None as it value. The default value of language becomes to 'en' now. Patch by Adam Turner and Takeshi KOMIYA.

Deprecated

5.0.0 b1

  • #​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/v5.3.0/sphinx/themes/basic/static .. code-block:: html+jinja

    {%- block scripts %} {{ super() }} {%- endblock %}

    Patch by Adam Turner.

  • 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

Features added

5.0.0 b1

  • #​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. Patch by Adam Turner.
  • #​10302: C++, add support for conditional expressions (?:).
  • #​5157, #​10251: Inline code is able to be highlighted via :dudir:role directive
  • #​10337: Make sphinx-build faster by caching Publisher object during build. Patch by Adam Turner.

Bugs fixed

5.0.0 b1

  • #​10200: apidoc: Duplicated submodules are shown for modules having both .pyx and .so files. Patch by Adam Turner and Takeshi KOMIYA.
  • #​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 @definfoenclose 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

5.0.0 final

  • #​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

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

  • If you want to rebase/retry this MR, check this box

This MR has been generated by Renovate Bot.

Edited by RenovateBot

Merge request reports