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 v8 #258

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 10, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
sphinx (changelog) ^7.0.0 -> ^8.0.0 age adoption passing confidence

Release Notes

sphinx-doc/sphinx (sphinx)

v8.1.3: Sphinx 8.1.3

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html

Bugs fixed

  • #​13013: Restore support for cut_lines() with no object type. Patch by Adam Turner.

v8.1.2: Sphinx 8.1.2

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Bugs fixed

  • #​13012: Expose sphinx.errors.ExtensionError in sphinx.util for backwards compatibility. This will be removed in Sphinx 9, as exposing the exception in sphinx.util was never intentional. ExtensionError has been part of sphinx.errors since Sphinx 0.9. Patch by Adam Turner.

v8.1.1: Sphinx 8.1.1

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Bugs fixed

  • #​13006: Use the preferred https://www.cve.org/ URL for
    the :cve: role.
    Patch by Hugo van Kemenade.
  • #​13007: LaTeX: Improve resiliency when the required
    fontawesome or fontawesome5 packages are not installed.
    Patch by Jean-François B.

v8.1.0

Compare Source

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

Dependencies

  • #​12756: Add lower-bounds to the sphinxcontrib-* dependencies.
    Patch by Adam Turner.
  • #​12833: Update the LaTeX parskip package from 2001 to 2018.
    Patch by Jean-François B.

Incompatible changes

  • #​12763: Remove unused internal class sphinx.util.Tee.
    Patch by Adam Turner.
  • #​12822: LaTeX: for Unicode engines, the :ref:fvset default is changed to
    '\\fvset{fontsize=auto}' from '\\fvset{fontsize=\\small}'.
    Code-blocks are unchanged as FreeMono is now loaded with Scale=0.9.
    An adjustment to existing projects is needed only if they used a custom
    :ref:fontpkg configuration and did not set :ref:fvset.
    Patch by Jean-François B.
  • #​12875: Disable smartquotes for languages: zh_CN and zh_TW by default.
    Patch by A. Rafey Khan.

Deprecated

  • #​12762: Deprecate sphinx.util.import_object.
    Use :py:func:importlib.import_module instead.
    Patch by Adam Turner.
  • #​12766: Deprecate sphinx.util.FilenameUniqDict
    and sphinx.util.DownloadFiles.
    Patch by Adam Turner.

Features added

  • #​11328: Mention evaluation of templated content during production of static
    output files.
    Patch by James Addison.
  • #​12704: LaTeX: make :dudir:contents <table-of-contents>, :dudir:topic,
    and :dudir:sidebar directives separately customizable for PDF output.
    Patch by Jean-François B. and Bénédikt Tran.
  • #​12474: Support type-dependent search result highlighting via CSS.
    Patch by Tim Hoffmann.
  • #​12652: LaTeX: Add :confval:math_numsep support to latex builder.
    Patch by Thomas Fanning and Jean-François B.
  • #​12743: No longer exit on the first warning when
    :option:--fail-on-warning <sphinx-build --fail-on-warning> is used.
    Instead, exit with a non-zero status if any warnings were generated
    during the build.
    Patch by Adam Turner.
  • #​12743: Add :option:sphinx-build --exception-on-warning,
    to raise an exception when warnings are emitted during the build.
    Patch by Adam Turner and Jeremy Maitin-Shepard.
  • #​12907: Add :confval:html_last_updated_use_utc to allow using
    universal time (GMT/UTC) instead of local time for the date-time
    supplied to :confval:html_last_updated_fmt.
    Patch by Adam Turner.
  • #​12910: Copyright entries now support the '%Y' placeholder
    to substitute the current year.
    This is helpful for reducing the reliance on Python modules
    such as :py:mod:time or :py:mod:datetime in :file:conf.py.
    See :ref:the docs <config-copyright> for further detail.
    Patch by Adam Turner.
  • #​11781: Add roles for referencing CVEs (:rst:role::cve: <cve>)
    and CWEs (:rst:role::cwe: <cwe>).
    Patch by Hugo van Kemenade.
  • #​11809: Improve the formatting for RFC section anchors.
    Patch by Jakub Stasiak and Adam Turner.
  • #​12852: Support a :attr:.Builder.supported_linkcode attribute
    for builders to enable use of :mod:sphinx.ext.linkcode-generated
    references.
    Patch by James Knight.
  • #​12949: Print configuration options that differ from the pickled environment.
    This can be helpful in diagnosing the cause of a full rebuild.
    Patch by Adam Turner.

Bugs fixed

  • #​12514: intersphinx: fix the meaning of a negative value for
    :confval:intersphinx_cache_limit.
    Patch by Shengyu Zhang.
  • #​12722: LaTeX: avoid TeX reporting Overfull \hbox from too long
    strings in a codeline when the problem has actually been solved thanks
    to :ref:latexsphinxsetupforcewraps.
    Patch by Jean-François B.
  • #​12730: The UnreferencedFootnotesDetector transform has been improved
    to more consistently detect unreferenced footnotes.
    Note, the priority of the transform has been changed from 200 to 622,
    so that it now runs after the docutils Footnotes resolution transform.
    Patch by Chris Sewell.
  • #​12778: LaTeX: let :ref:'sphinxsetup' <latexsphinxsetup>
    div.topic_box-shadow key if used with only one dimension set both
    x-offset and y-offset as per documentation.
    Patch by Jean-François B.
  • #​12587: Do not warn when potential ambiguity detected during Intersphinx
    resolution occurs due to duplicate targets that differ case-insensitively.
    Patch by James Addison.
  • #​12639: Fix singular and plural search results text.
    Patch by Hugo van Kemenade.
  • #​12645: Correctly support custom gettext output templates.
    Patch by Jeremy Bowman.
  • #​12717: LaTeX: let :option:-q <sphinx-build -q> (quiet) option for
    :program:sphinx-build -M latexpdf or :program:make latexpdf (O=-q)
    get passed to :program:latexmk. Let :option:-Q <sphinx-build -Q>
    (silent) apply as well to the PDF build phase.
    Patch by Jean-François B.
  • #​12744: LaTeX: Classes injected by a custom interpreted text role now give
    rise to nested \DUrole's, rather than a single one with comma separated
    classes.
    Patch by Jean-François B.
  • #​12831: LaTeX: avoid large voids sometimes occurring at page bottoms.
    Patch by Jean-François B.
  • #​11970, #​12551: singlehtml builder: make target URIs to be same-document
    references in the sense of :rfc:RFC 3986, §4.4 <3986#section-4.4>,
    e.g., index.html#foo becomes #foo.
    (note: continuation of a partial fix added in Sphinx 7.3.0)
    Patch by James Addison (with reference to prior work by Eric Norige).
  • #​12735: Fix :pep:695 generic classes LaTeX output formatting.
    Patch by Jean-François B. and Bénédikt Tran.
  • #​12782: intersphinx: fix double forward slashes when generating the inventory
    file URL (user-defined base URL of an intersphinx project are left untouched
    even if they end with double forward slashes).
    Patch by Bénédikt Tran.
  • #​12796: Enable parallel reading if requested,
    even if there are fewer than 6 documents.
    Patch by Matthias Geier.
  • #​12844: Restore support for :noindex: for the :rst:dir:js:module
    and :rst:dir:py:module directives.
    Patch by Stephen Finucane.
  • #​12916: Restore support for custom templates named with the legacy _t
    suffix during apidoc RST rendering (regression in 7.4.0).
    Patch by James Addison.
  • #​12451: Only substitute copyright notice years with values from
    SOURCE_DATE_EPOCH for entries that match the current system clock year,
    and disallow substitution of future years.
    Patch by James Addison and Adam Turner.
  • #​12905: intersphinx: fix flipped use of :confval:intersphinx_cache_limit,
    which always kept the cache for positive values, and always refreshed it for
    negative ones.
    Patch by Nico Madysa.
  • #​12888: Add a warning when document is included in multiple toctrees
    and ensure deterministic resolution of global toctree in parallel builds
    by choosing the lexicographically greatest parent document.
    Patch by A. Rafey Khan
  • #​12995: Significantly improve performance when building the search index
    for Chinese languages.
    Patch by Adam Turner.
  • #​12767: :py:meth:.Builder.write is typed as final, meaning that the
    :event:write-started event may be relied upon by extensions.
    A new :py:meth:.Builder.write_documents method has been added to
    control how documents are written.
    This is intended for builders that do not output a file for each document.
    Patch by Adam Turner.

Testing

  • #​12141: Migrate from the deprecated karma JavaScript test framework to
    the actively-maintained jasmine framework. Test coverage is unaffected.
    Patch by James Addison.

v8.0.2: Sphinx 8.0.2

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v8.0.1: Sphinx 8.0.1

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v8.0.0: Sphinx 8.0.0

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Dependencies

Incompatible changes

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

    Patch by Adam Turner.

  • Removed sphinx.util.osutil.cd
    (use contextlib.chdir).
    Patch by Adam Turner.

  • Removed sphinx.util.typing.stringify
    (use sphinx.util.typing.stringify_annotation).
    Patch by Adam Turner.

  • #​12593: Raise an error for invalid html_sidebars values.
    Patch by Adam Turner.

  • #​12593: Raise an error in Theme.get_config for invalid sections.
    Patch by Adam Turner.

  • #​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.
    Patch by Adam Turner.

  • Removed the tuple interface to sphinx.ext.autodoc.ObjectMember.
    Patch by Adam Turner.

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

    Patch by James Addison.

  • #​12597: Change the default of show_warning_types
    from False to True.
    Patch by Chris Sewell.

  • #​12083: Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6
    intersphinx_mapping format.
    Patch by Bénédikt Tran and Adam Turner.

  • #​12096: Do not overwrite user-supplied files when copying assets
    unless forced with force=True.
    Patch by Adam Turner.

  • #​12646: Remove sphinx.util.inspect.isNewType.
    Use isinstance(obj, typing.NewType) instead on Python 3.10 and newer.
    Patch by Adam Turner.

  • Remove the long-deprecated (since Sphinx 2) alias
    to VersionChange in
    sphinx.directives.other
    (Deprecated since Sphinx 2).
    Use sphinx.domains.changeset.VersionChange directly.
    Patch by Adam Turner.

Deprecated

  • #​12643: Renamed sphinx.ext.intersphinx.normalize_intersphinx_mapping
    to sphinx.ext.intersphinx.validate_intersphinx_mapping.
    The old name will be removed in Sphinx 10.
    Patch by Adam Turner.
  • #​12650, #​12686, #​12690: Extend the deprecation for string methods on
    pathlib.Path objects to Sphinx 9.
    Use os.fspath to convert :py:class:~pathlib.Path objects to strings,
    or pathlib.Path's methods to work with path objects.
    Patch by Adam Turner.

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-8.x branch from c470541 to 6318a6f Compare December 26, 2024 12:17
@NiceAesth NiceAesth closed this Dec 26, 2024
Copy link
Contributor Author

renovate bot commented Dec 26, 2024

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 8.x releases. But if you manually upgrade to 8.x then Renovate will re-enable minor and patch updates automatically.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

@renovate renovate bot deleted the renovate/sphinx-8.x branch December 26, 2024 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant