Update dependency Sphinx to v6 (release/4.0.x)

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
Sphinx (changelog)	==5.3.0 -> ==6.1.3

---

⚠ Dependency Lookup Warnings ⚠

Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information.

---

Release Notes

sphinx-doc/sphinx

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 contents_ boxes not in page
  margin since Sphinx 5.1.0

  .. _contents: https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents

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

• Adopted the Ruff_ code linter.

  .. _Ruff: https://github.com/charliermarsh/ruff

Incompatible changes

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

Deprecated

• sphinx.util functions:

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

  Moved to sphinx.util.display:

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

  Moved to sphinx.util.http_date:

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

  Moved to sphinx.util.exceptions:

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

Features added

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

Bugs fixed

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

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 %} <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script> <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
  {{ 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.

---

Configuration

📅 Schedule: Branch creation - "before 2am" (UTC), Automerge - At any time (no schedule defined).

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

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

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

---

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

---

This PR has been generated by Mend Renovate. View repository job log here.

[gitpod-io]

[renovate]

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.
You can manually request rebase by checking the rebase/retry box above.

⚠ Warning: custom changes will be lost.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[renovate]

Renovate Ignore Notification

As this PR has been closed unmerged, Renovate will ignore this upgrade and you will not receive PRs for any future 6.x releases. However, if you upgrade to 6.x manually then Renovate will reenable minor and patch updates automatically.

If this PR was closed by mistake or you changed your mind, you can simply rename this PR and you will soon get a fresh replacement PR opened.