Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(deps): update dependency sphinx to v6 #84

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Jul 31, 2023

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
Sphinx (changelog) 5.3.0 -> 6.2.1 age adoption passing confidence
sphinx (changelog) ==5.3.0 -> ==6.2.1 age adoption passing confidence

Release Notes

sphinx-doc/sphinx (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 %} <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 - 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 PR is behind base branch, or you tick the rebase/retry checkbox.

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


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

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 5 times, most recently from 99d0ae3 to 519ebc6 Compare August 3, 2023 12:07
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 3 times, most recently from 8391f2e to 6736c41 Compare August 13, 2023 03:12
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 4 times, most recently from 9408b6d to 4b1d7ad Compare August 22, 2023 00:14
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 5 times, most recently from c84ed7c to c540811 Compare September 4, 2023 15:41
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 5 times, most recently from d6f8379 to 52aae5b Compare September 11, 2023 06:51
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 3 times, most recently from 0f24bf3 to 946c610 Compare October 7, 2023 22:00
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 2 times, most recently from 2bf711e to 6b90951 Compare October 17, 2023 21:50
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from 6b90951 to 122fee2 Compare October 24, 2023 01:30
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 2 times, most recently from 762aa34 to c516095 Compare November 8, 2023 11:35
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 3 times, most recently from 3eddd00 to 22af6a6 Compare March 6, 2024 22:13
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from 22af6a6 to 1702985 Compare March 15, 2024 01:11
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from 1702985 to 0621721 Compare March 22, 2024 21:48
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from 0621721 to 797b86b Compare April 6, 2024 23:04
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 2 times, most recently from 9202edf to bf92566 Compare April 26, 2024 22:09
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from bf92566 to b2f4e24 Compare May 4, 2024 20:31
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 2 times, most recently from 70e7a88 to 1d2fe60 Compare May 28, 2024 18:01
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from 1d2fe60 to 914d0bf Compare June 6, 2024 03:47
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from 914d0bf to 6d2c86b Compare June 23, 2024 04:36
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from 6d2c86b to 1a4c281 Compare July 3, 2024 08:27
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from 1a4c281 to 8cac03b Compare July 11, 2024 20:41
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 3 times, most recently from 484501b to 7a5cc13 Compare August 7, 2024 21:46
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from 7a5cc13 to ba39ae9 Compare August 13, 2024 23:08
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from ba39ae9 to 7326e0e Compare September 7, 2024 18:11
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 2 times, most recently from bef626a to 1c9287b Compare September 19, 2024 11:06
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 3 times, most recently from c7cfedf to 799e2f3 Compare October 3, 2024 19:59
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch 3 times, most recently from 7d0d742 to f6909ba Compare October 22, 2024 10:34
@renovate renovate bot force-pushed the renovate/sphinx-6.x branch from f6909ba to ba254a0 Compare October 22, 2024 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants