user_guide
user_guide copied to clipboard
Update sphinx requirement from ==7.* to ==8.*
Updates the requirements on sphinx to permit the latest version.
Release notes
Sourced from sphinx's releases.
Sphinx 8.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Dependencies
- #12633: Drop Python 3.9 support.
Incompatible changes
Remove deprecated functions from
sphinx.util
:
- Removed
sphinx.util.path_stabilize
(usesphinx.util.osutil.path_stabilize
).- Removed
sphinx.util.display_chunk
(usesphinx.util.display.display_chunk
).- Removed
sphinx.util.status_iterator
(usesphinx.util.display.status_iterator
).- Removed
sphinx.util.SkipProgressMessage
(usesphinx.util.display.SkipProgressMessage
).- Removed
sphinx.util.progress_message
(usesphinx.util.display.progress_message
).- Removed
sphinx.util.epoch_to_rfc1123
(usesphinx.http_date.epoch_to_rfc1123
).- Removed
sphinx.util.rfc1123_to_epoch
(usesphinx.http_date.rfc1123_to_epoch
).- Removed
sphinx.util.save_traceback
(usesphinx.exceptions.save_traceback
).- Removed
sphinx.util.format_exception_cut_frames
(usesphinx.exceptions.format_exception_cut_frames
).- Removed
sphinx.util.xmlname_checker
(usesphinx.builders.epub3._XML_NAME_PATTERN
).Patch by Adam Turner.
Removed
sphinx.util.osutil.cd
(usecontextlib.chdir
). Patch by Adam Turner.Removed
sphinx.util.typing.stringify
(usesphinx.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 insphinx-quickstart
.#11693: Remove the
--no-use-make-mode
,-M
,--use-make-mode
, and-m
options fromsphinx-quickstart
.
... (truncated)
Changelog
Sourced from sphinx's changelog.
Release 8.0.0 (released Jul 29, 2024)
Dependencies
- #12633: Drop Python 3.9 support.
Incompatible changes
.. rst-class:: compact
Remove deprecated functions from
sphinx.util
:
- Removed
sphinx.util.path_stabilize
(usesphinx.util.osutil.path_stabilize
).- Removed
sphinx.util.display_chunk
(usesphinx.util.display.display_chunk
).- Removed
sphinx.util.status_iterator
(usesphinx.util.display.status_iterator
).- Removed
sphinx.util.SkipProgressMessage
(usesphinx.util.display.SkipProgressMessage
).- Removed
sphinx.util.progress_message
(usesphinx.util.display.progress_message
).- Removed
sphinx.util.epoch_to_rfc1123
(usesphinx.http_date.epoch_to_rfc1123
).- Removed
sphinx.util.rfc1123_to_epoch
(usesphinx.http_date.rfc1123_to_epoch
).- Removed
sphinx.util.save_traceback
(usesphinx.exceptions.save_traceback
).- Removed
sphinx.util.format_exception_cut_frames
(usesphinx.exceptions.format_exception_cut_frames
).- Removed
sphinx.util.xmlname_checker
(usesphinx.builders.epub3._XML_NAME_PATTERN
).Patch by Adam Turner.
Removed :py:func:
!sphinx.util.osutil.cd
(use :py:func:contextlib.chdir
). Patch by Adam Turner.Removed :py:func:
!sphinx.util.typing.stringify
(use :py:func:!sphinx.util.typing.stringify_annotation
). Patch by Adam Turner.#12593: Raise an error for invalid :confval:
html_sidebars
values. Patch by Adam Turner.#12593: Raise an error in :py:func:
!Theme.get_config
for invalid sections. Patch by Adam Turner.#11693: Remove support for old-style :file:
Makefile
and :file:make.bat
output in :program:sphinx-quickstart
.#11693: Remove the :option:
!--no-use-make-mode
, :option:!-M
,
... (truncated)
Commits
0e8a638
Bump to 8.0.0 final5750d0e
[bot]: Update message catalogues (#12641)c1ed1e3
UsePath
objects withincopyfile
(#12708)a4102a7
Specify encoding to avoid EncodingWarningb0485f9
Add a migration note forisNewType
feeee57
[HTML theme] sphinx13: include the project name in home link (#12700)0cb3c07
Add a missing space5f110f0
Fix test failures following Alabaster's change in default sidebars08adbb3
Fix positioning of logos on the homepage (#12684)e2843fd
Bump Ruff to 0.5.5- Additional commits viewable in compare view
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase
.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
-
@dependabot rebase
will rebase this PR -
@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it -
@dependabot merge
will merge this PR after your CI passes on it -
@dependabot squash and merge
will squash and merge this PR after your CI passes on it -
@dependabot cancel merge
will cancel a previously requested merge and block automerging -
@dependabot reopen
will reopen this PR if it is closed -
@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually -
@dependabot show <dependency name> ignore conditions
will show all of the ignore conditions of the specified dependency -
@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) -
@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) -
@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)