Update dependency sphinx to v8 #142
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
|
renovate
bot
force-pushed
the
renovate/sphinx-8.x
branch
from
d5ee95f
to
a94b354
Compare
renovate
bot
force-pushed
the
renovate/sphinx-8.x
branch
from
a94b354
to
d3805bf
Compare
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^7.0->^8.0.0Release Notes
sphinx-doc/sphinx (sphinx)
v8.1.3: Sphinx 8.1.3Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Bugs fixed
cut_lines()with no object type. Patch by Adam Turner.v8.1.2: Sphinx 8.1.2Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Bugs fixed
sphinx.errors.ExtensionErrorinsphinx.utilfor backwards compatibility. This will be removed in Sphinx 9, as exposing the exception insphinx.utilwas never intentional.ExtensionErrorhas been part ofsphinx.errorssince Sphinx 0.9. Patch by Adam Turner.v8.1.1: Sphinx 8.1.1Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Bugs fixed
the
:cve:role.Patch by Hugo van Kemenade.
fontawesomeorfontawesome5packages are not installed.Patch by Jean-François B.
v8.1.0Compare Source
=====================================
Dependencies
sphinxcontrib-*dependencies.Patch by Adam Turner.
parskippackage from 2001 to 2018.Patch by Jean-François B.
Incompatible changes
sphinx.util.Tee.Patch by Adam Turner.
fvsetdefault 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:
fontpkgconfiguration and did not set :ref:fvset.Patch by Jean-François B.
zh_CNandzh_TWby default.Patch by A. Rafey Khan.
Deprecated
sphinx.util.import_object.Use :py:func:
importlib.import_moduleinstead.Patch by Adam Turner.
sphinx.util.FilenameUniqDictand
sphinx.util.DownloadFiles.Patch by Adam Turner.
Features added
output files.
Patch by James Addison.
contents <table-of-contents>, :dudir:topic,and :dudir:
sidebardirectives separately customizable for PDF output.Patch by Jean-François B. and Bénédikt Tran.
Patch by Tim Hoffmann.
math_numsepsupport to latex builder.Patch by Thomas Fanning and Jean-François B.
: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.
sphinx-build --exception-on-warning,to raise an exception when warnings are emitted during the build.
Patch by Adam Turner and Jeremy Maitin-Shepard.
html_last_updated_use_utcto allow usinguniversal time (GMT/UTC) instead of local time for the date-time
supplied to :confval:
html_last_updated_fmt.Patch by Adam Turner.
'%Y'placeholderto substitute the current year.
This is helpful for reducing the reliance on Python modules
such as :py:mod:
timeor :py:mod:datetimein :file:conf.py.See :ref:
the docs <config-copyright>for further detail.Patch by Adam Turner.
:cve: <cve>)and CWEs (:rst:role:
:cwe: <cwe>).Patch by Hugo van Kemenade.
Patch by Jakub Stasiak and Adam Turner.
.Builder.supported_linkcodeattributefor builders to enable use of :mod:
sphinx.ext.linkcode-generatedreferences.
Patch by James Knight.
This can be helpful in diagnosing the cause of a full rebuild.
Patch by Adam Turner.
Bugs fixed
:confval:
intersphinx_cache_limit.Patch by Shengyu Zhang.
Overfull \hboxfrom too longstrings in a codeline when the problem has actually been solved thanks
to :ref:
latexsphinxsetupforcewraps.Patch by Jean-François B.
UnreferencedFootnotesDetectortransform has been improvedto 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
Footnotesresolution transform.Patch by Chris Sewell.
'sphinxsetup' <latexsphinxsetup>div.topic_box-shadowkey if used with only one dimension set bothx-offset and y-offset as per documentation.
Patch by Jean-François B.
resolution occurs due to duplicate targets that differ case-insensitively.
Patch by James Addison.
Patch by Hugo van Kemenade.
Patch by Jeremy Bowman.
-q <sphinx-build -q>(quiet) option for:program:
sphinx-build -M latexpdfor :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.
rise to nested
\DUrole's, rather than a single one with comma separatedclasses.
Patch by Jean-François B.
Patch by Jean-François B.
references in the sense of :rfc:
RFC 3986, §4.4 <3986#section-4.4>,e.g.,
index.html#foobecomes#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).
695generic classes LaTeX output formatting.Patch by Jean-François B. and Bénédikt Tran.
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.
even if there are fewer than 6 documents.
Patch by Matthias Geier.
:noindex:for the :rst:dir:js:moduleand :rst:dir:
py:moduledirectives.Patch by Stephen Finucane.
_tsuffix during
apidocRST rendering (regression in 7.4.0).Patch by James Addison.
SOURCE_DATE_EPOCHfor entries that match the current system clock year,and disallow substitution of future years.
Patch by James Addison and Adam Turner.
intersphinx_cache_limit,which always kept the cache for positive values, and always refreshed it for
negative ones.
Patch by Nico Madysa.
and ensure deterministic resolution of global toctree in parallel builds
by choosing the lexicographically greatest parent document.
Patch by A. Rafey Khan
for Chinese languages.
Patch by Adam Turner.
.Builder.writeis typed asfinal, meaning that the:event:
write-startedevent may be relied upon by extensions.A new :py:meth:
.Builder.write_documentsmethod has been added tocontrol how documents are written.
This is intended for builders that do not output a file for each document.
Patch by Adam Turner.
Testing
karmaJavaScript test framework tothe actively-maintained
jasmineframework. Test coverage is unaffected.Patch by James Addison.
v8.0.2: Sphinx 8.0.2Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v8.0.1: Sphinx 8.0.1Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v8.0.0: Sphinx 8.0.0Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Dependencies
Incompatible changes
Remove deprecated functions from
sphinx.util:sphinx.util.path_stabilize(use
sphinx.util.osutil.path_stabilize).sphinx.util.display_chunk(use
sphinx.util.display.display_chunk).sphinx.util.status_iterator(use
sphinx.util.display.status_iterator).sphinx.util.SkipProgressMessage(use
sphinx.util.display.SkipProgressMessage).sphinx.util.progress_message(use
sphinx.util.display.progress_message).sphinx.util.epoch_to_rfc1123(use
sphinx.http_date.epoch_to_rfc1123).sphinx.util.rfc1123_to_epoch(use
sphinx.http_date.rfc1123_to_epoch).sphinx.util.save_traceback(use
sphinx.exceptions.save_traceback).sphinx.util.format_exception_cut_frames(use
sphinx.exceptions.format_exception_cut_frames).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_sidebarsvalues.Patch by Adam Turner.
#12593: Raise an error in
Theme.get_configfor invalid sections.Patch by Adam Turner.
#11693: Remove support for old-style
Makefileandmake.batoutput in
sphinx-quickstart.#11693: Remove the
--no-use-make-mode,-M,--use-make-mode, and-moptionsfrom
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
linkcheckconfiguration defaults:linkcheck_allow_unauthorizedis nowFalseby default.linkcheck_report_timeouts_as_brokenis nowFalseby default.Patch by James Addison.
#12597: Change the default of
show_warning_typesfrom
FalsetoTrue.Patch by Chris Sewell.
#12083: Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6
intersphinx_mappingformat.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
VersionChangeinsphinx.directives.other(Deprecated since Sphinx 2).
Use
sphinx.domains.changeset.VersionChangedirectly.Patch by Adam Turner.
Deprecated
sphinx.ext.intersphinx.normalize_intersphinx_mappingto
sphinx.ext.intersphinx.validate_intersphinx_mapping.The old name will be removed in Sphinx 10.
Patch by Adam Turner.
pathlib.Pathobjects to Sphinx 9.Use
os.fspathto convert :py:class:~pathlib.Pathobjects 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 becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.