fix(deps): update dependency sphinx to v8 #258
Closed
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.0
->^8.0.0
Release 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.ExtensionError
insphinx.util
for backwards compatibility. This will be removed in Sphinx 9, as exposing the exception insphinx.util
was never intentional.ExtensionError
has been part ofsphinx.errors
since 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.
fontawesome
orfontawesome5
packages are not installed.Patch by Jean-François B.
v8.1.0
Compare Source
=====================================
Dependencies
sphinxcontrib-*
dependencies.Patch by Adam Turner.
parskip
package from 2001 to 2018.Patch by Jean-François B.
Incompatible changes
sphinx.util.Tee
.Patch by Adam Turner.
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.
zh_CN
andzh_TW
by default.Patch by A. Rafey Khan.
Deprecated
sphinx.util.import_object
.Use :py:func:
importlib.import_module
instead.Patch by Adam Turner.
sphinx.util.FilenameUniqDict
and
sphinx.util.DownloadFiles
.Patch by Adam Turner.
Features added
output files.
Patch by James Addison.
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.
Patch by Tim Hoffmann.
math_numsep
support 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_utc
to 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:
time
or :py:mod:datetime
in :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_linkcode
attributefor 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 \hbox
from too longstrings in a codeline when the problem has actually been solved thanks
to :ref:
latexsphinxsetupforcewraps
.Patch by Jean-François B.
UnreferencedFootnotesDetector
transform 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
Footnotes
resolution transform.Patch by Chris Sewell.
'sphinxsetup' <latexsphinxsetup>
div.topic_box-shadow
key 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 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.
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#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).
695
generic 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:module
and :rst:dir:
py:module
directives.Patch by Stephen Finucane.
_t
suffix during
apidoc
RST rendering (regression in 7.4.0).Patch by James Addison.
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.
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.write
is typed asfinal
, meaning that the:event:
write-started
event may be relied upon by extensions.A new :py:meth:
.Builder.write_documents
method 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
karma
JavaScript test framework tothe actively-maintained
jasmine
framework. 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_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
andmake.bat
output in
sphinx-quickstart
.#11693: Remove the
--no-use-make-mode
,-M
,--use-make-mode
, and-m
optionsfrom
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 nowFalse
by default.linkcheck_report_timeouts_as_broken
is nowFalse
by default.Patch by James Addison.
#12597: Change the default of
show_warning_types
from
False
toTrue
.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
insphinx.directives.other
(Deprecated since Sphinx 2).
Use
sphinx.domains.changeset.VersionChange
directly.Patch by Adam Turner.
Deprecated
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.
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.
This PR was generated by Mend Renovate. View the repository job log.