chore(deps): update dependency sphinx to v8 #298

renovate · 2024-07-30T19:24:11Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
Sphinx (changelog)	`7.4.7` -> `8.2.0`

Release Notes

sphinx-doc/sphinx (Sphinx)

`v8.2.0`

Compare Source

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

Dependencies

#13000: Drop Python 3.10 support.

Incompatible changes

#13044: Remove the internal and undocumented has_equations data
from the :py:class:!MathDomain domain.
The undocumented :py:meth:!MathDomain.has_equations method
now unconditionally returns True.
These are replaced by the has_maths_elements key of the page context dict.
Patch by Adam Turner.
#13227: HTML output for sequences of keys in the :rst:role:kbd role
no longer uses a <kbd class="kbd compound"> element to wrap
the keys and separators, but places them directly in the relevant parent node.
This means that CSS rulesets targeting kbd.compound or .kbd.compound
will no longer have any effect.
Patch by Adam Turner.

Deprecated

#13037: Deprecate the SingleHTMLBuilder.fix_refuris method.
Patch by James Addison.
#13083, #13330: Un-deprecate sphinx.util.import_object.
Patch by Matthias Geier.

Features added

#13173: Add a new duplicate_declaration warning type,
with duplicate_declaration.c and duplicate_declaration.cpp subtypes.
Patch by Julien Lecomte and Adam Turner.
#11824: linkcode: Allow extensions to add support for a domain by defining
the keys that should be present.
Patch by Nicolas Peugnet.
#13144: Add a class option to the :rst:dir:autosummary directive.
Patch by Tim Hoffmann.
#13146: Napoleon: Unify the type preprocessing logic to allow
Google-style docstrings to use the optional and default keywords.
Patch by Chris Barrick.
#13227: Implement the :rst:role:kbd role as a SphinxRole.
Patch by Adam Turner.
#13065: Enable colour by default in when running on CI.
Patch by Adam Turner.
#13230: Allow supressing warnings from the :rst:dir:toctree directive
when a glob pattern doesn't match any documents,
via the new toc.empty_glob warning sub-type.
Patch by Slawek Figiel.
#9732: Add the new autodoc.mocked_object warnings sub-type.
Patch by Cyril Roelandt.
#7630, #4824: autodoc: Use :file:.pyi type stub files
to auto-document native modules.
Patch by Adam Turner, partially based on work by Allie Fitter.
#12975: Enable configuration of trailing commas in multi-line signatures
in the Python and Javascript domains, via the new
:confval:python_trailing_comma_in_multi_line_signatures and
:confval:javascript_trailing_comma_in_multi_line_signatures
configuration options.
#13264: Rename the :rst:dir:math directive's nowrap option
to :rst:dir:math:no-wrap.
Patch by Adam Turner.
#13269: Added the option to disable the use of type comments in
via the new :confval:autodoc_use_type_comments option,
which defaults to True for backwards compatibility.
The default will change to False in Sphinx 10.
Patch by Adam Turner.
#9732: Add the new ref.any warnings sub-type
to allow suppressing the ambiguous 'any' cross-reference warning.
Patch by Simão Afonso and Adam Turner.
#13272: The Python and JavaScript module directives now support
the :no-index-entry: option.
Patch by Adam Turner.
#12233: autodoc: Allow directives to use :no-index-entry:
and include the :no-index: and :no-index-entry: options within
:confval:autodoc_default_options.
Patch by Jonny Saunders and Adam Turner.
#13172: Add support for short signatures in autosummary.
Patch by Tim Hoffmann.
#13271: Change the signature prefix for abstract methods
in the Python domain to abstractmethod from abstract.
Patch by Adam Turner.
#13271: Support the :abstract: option for
classes, methods, and properties in the Python domain.
Patch by Adam Turner.
#12507: Add the :ref:collapsible <collapsible-admonitions> option
to admonition directives.
Patch by Chris Sewell.
#8191, #8159: Add :rst:dir:inheritance-diagram:include-subclasses option to
the :rst:dir:inheritance-diagram directive.
Patch by Walter Dörwald.
#11995: autodoc: Add support for :confval:python_display_short_literal_types.
Patch by Bénédikt Tran and Adam Turner.
#13163: Always print the full context when Sphinx encounters an internal error.
Patch by Kevin Deldycke and Adam Turner.
#13105: Introduce the :rst:role:py:deco role to cross-reference decorator
functions and methods in the Python domain.
Patch by Adam Turner.
#9169: Add the :confval:intersphinx_resolve_self option
to resolve an intersphinx reference to the current project.
Patch by Jakob Lykke Andersen and Adam Turner.
#11280: Add ability to skip a particular section using the no-search class.
Patch by Will Lachance.
#13326: Remove hardcoding from handling :class:~sphinx.addnodes.productionlist
nodes in all writers, to improve flexibility.
Patch by Adam Turner.
#13335: Use misc.highlighting_failure subtype for Pygments unknown lexers.
Patch by Bart Kamphorst.
#13354: Insert abbreviation nodes (hover text) for positional- and keyword-only
separators in Python signatures.
Patch by Adam Turner.
#13333: Add the :mod:sphinx.ext.apidoc extension,
to automate API documentation generation from Python modules.
Patch by Chris Sewell and Adam Turner.

Bugs fixed

#12463: autosummary: Respect an empty module __all__.
Patch by Valentin Pratz
#13060: HTML Search: use Map to store per-file term scores.
Patch by James Addison
#13130: LaTeX docs: pdflatex index creation may fail for index entries
in French. See :confval:latex_use_xindy.
Patch by Jean-François B.
#13152: LaTeX: fix a typo from v7.4.0 in a default for \sphinxboxsetup.
Patch by Jean-François B.
#13096: HTML Search: check that query terms exist as properties in
term indices before accessing them.
#11233: linkcheck: match redirect URIs against :confval:linkcheck_ignore by
overriding session-level requests.get_redirect_target.
#13195: viewcode: Fix issue where import paths differ from the directory
structure.
Patch by Ben Egan and Adam Turner.
#13188: autodoc: fix detection of class methods implemented in C.
Patch by Bénédikt Tran.
#1810: Always copy static files when building, regardless of whether
any documents have changed since the previous build.
Patch by Adam Turner.
#13201: autodoc: fix ordering of members when using groupwise
for :confval:autodoc_member_order. Class methods are now rendered
before static methods, which themselves are rendered before regular
methods and attributes.
Patch by Bénédikt Tran.
#12975: Avoid rendering a trailing comma in C and C++ multi-line signatures.
#13178: autodoc: Fix resolution for pathlib types.
Patch by Adam Turner.
#13136: autodoc: Correctly handle multiple inheritance.
Patch by Pavel Holica
#13273, #13318: Properly convert command-line overrides for Boolean types.
Patch by Adam Turner.
#13302, #13319: Use the correct indentation for continuation lines
in :rst:dir:productionlist directives.
Patch by Adam Turner.
#13328: Fix parsing of PEP 695 functions with return annotations.
Patch by Bénédikt Tran. Initial work by Arash Badie-Modiri.

Testing

#13224: Correctness fixup for test_html_multi_line_copyright.
Patch by Colin Watson, applied by James Addison.

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

Dependencies

#12633: Drop Python 3.9 support.

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 this update 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 · 2024-07-30T19:24:12Z

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

any of the package files in this branch needs updating, or
the branch becomes conflicted, or
you click the rebase/retry checkbox if found above, or
you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: poetry.lock

Updating dependencies
Resolving dependencies...

Creating virtualenv pysolcast-fiRQzp1F-py3.13 in /home/ubuntu/.cache/pypoetry/virtualenvs

The current project's supported Python range (>=3.9) is not compatible with some of the required packages Python requirement:
  - sphinx requires Python >=3.11, so it will not be satisfied for Python >=3.9,<3.11

Because pysolcast depends on sphinx (8.2.0) which requires Python >=3.11, version solving failed.

  • Check your dependencies Python requirement: The Python requirement can be specified via the `python` or `markers` properties
    
    For sphinx, a possible solution would be to set the `python` property to ">=3.11"

    https://python-poetry.org/docs/dependency-specification/#python-restricted-dependencies,
    https://python-poetry.org/docs/dependency-specification/#using-environment-markers

github-actions · 2024-07-30T19:24:39Z

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Manifest Files

codeclimate · 2024-10-13T22:06:23Z

Code Climate has analyzed commit 6e91e3a and detected 0 issues on this pull request.

View more on Code Climate.

renovate bot force-pushed the renovate/sphinx-8.x branch 7 times, most recently from 90eeb85 to 8fbe24e Compare August 5, 2024 13:22

renovate bot force-pushed the renovate/sphinx-8.x branch 4 times, most recently from 7d139b0 to 2122f5b Compare August 10, 2024 12:41

renovate bot force-pushed the renovate/sphinx-8.x branch 6 times, most recently from fd88236 to 4274abc Compare September 4, 2024 22:47

renovate bot force-pushed the renovate/sphinx-8.x branch 4 times, most recently from 9ee47a3 to 6e91e3a Compare October 13, 2024 22:06

renovate bot force-pushed the renovate/sphinx-8.x branch 2 times, most recently from 50dc0cc to 5649d6c Compare November 20, 2024 12:25

chore(deps): update dependency sphinx to v8

1daa9ee

renovate bot force-pushed the renovate/sphinx-8.x branch from 5649d6c to 1daa9ee Compare February 18, 2025 21:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(deps): update dependency sphinx to v8 #298

chore(deps): update dependency sphinx to v8 #298

renovate bot commented Jul 30, 2024 •

edited

Loading

renovate bot commented Jul 30, 2024 •

edited

Loading

github-actions bot commented Jul 30, 2024 •

edited

Loading

codeclimate bot commented Oct 13, 2024

chore(deps): update dependency sphinx to v8 #298

Are you sure you want to change the base?

chore(deps): update dependency sphinx to v8 #298

Conversation

renovate bot commented Jul 30, 2024 • edited Loading

Release Notes

v8.2.0

Dependencies

Incompatible changes

Deprecated

Features added

Bugs fixed

Testing

v8.1.3: Sphinx 8.1.3

Bugs fixed

v8.1.2: Sphinx 8.1.2

Bugs fixed

v8.1.1: Sphinx 8.1.1

Bugs fixed

v8.1.0

Dependencies

Incompatible changes

Deprecated

Features added

Bugs fixed

Testing

v8.0.2: Sphinx 8.0.2

v8.0.1: Sphinx 8.0.1

v8.0.0: Sphinx 8.0.0

Dependencies

Incompatible changes

Deprecated

Configuration

renovate bot commented Jul 30, 2024 • edited Loading

⚠️ Artifact update problem

File name: poetry.lock

github-actions bot commented Jul 30, 2024 • edited Loading

Dependency Review

OpenSSF Scorecard

Scanned Manifest Files

codeclimate bot commented Oct 13, 2024

renovate bot commented Jul 30, 2024 •

edited

Loading

`v8.2.0`

`v8.1.3`: Sphinx 8.1.3

`v8.1.2`: Sphinx 8.1.2

`v8.1.1`: Sphinx 8.1.1

`v8.1.0`

`v8.0.2`: Sphinx 8.0.2

`v8.0.1`: Sphinx 8.0.1

`v8.0.0`: Sphinx 8.0.0

renovate bot commented Jul 30, 2024 •

edited

Loading

github-actions bot commented Jul 30, 2024 •

edited

Loading