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

chore(deps): update dependency sphinx to >=7.4,<7.5 #414

Merged
merged 1 commit into from
Jul 15, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jul 15, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
sphinx (changelog) >=7.3.4,<7.4 -> >=7.4,<7.5 age adoption passing confidence

Release Notes

sphinx-doc/sphinx (sphinx)

v7.4.0

Compare Source

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

Dependencies

  • #​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' <latexsphinxsetup> for more.

Deprecated

  • LaTeX: the sphinxlightbox environment is not used anymore, all types
    of admonitions use (by default) only sphinxheavybox.

Features added

.. rst-class:: compact

  • #​11165: Support the officially recommended_ .jinja suffix for template
    files.
    Patch by James Addison and Adam Turner

    .. _officially recommended: https://jinja.palletsprojects.com/en/latest/templates/#template-file-extension

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

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

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

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

  • #​12448: Add :option:sphinx-apidoc --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.

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

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

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

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

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

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

  • #​12506: Add level option to :rst:dir:rubric directive.
    Patch by Chris Sewell.

  • #​12567: Add the :event:write-started event.
    Patch by Chris Sewell.

Bugs fixed

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

Testing

  • karma: refactor HTML search tests to use fixtures generated by Sphinx.
    Patch by James Addison.

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 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.

Copy link

codecov bot commented Jul 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.94%. Comparing base (7d792eb) to head (8411266).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #414   +/-   ##
=======================================
  Coverage   92.94%   92.94%           
=======================================
  Files          64       64           
  Lines        2878     2878           
=======================================
  Hits         2675     2675           
  Misses        203      203           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jooola jooola merged commit 8d2c942 into main Jul 15, 2024
10 checks passed
@jooola jooola deleted the renovate/sphinx-7.x branch July 15, 2024 08:14
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.

1 participant