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
-
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
.
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
fromFalse
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 withforce=True
.
Patch by Adam Turner. -
#12650: Remove support for string methods on
pathlib.Path
objects.
Useos.fspath
to convertpathlib.Path
objects to strings,
orpathlib.Path
's methods to work with path objects.
Patch by Adam Turner. -
#12646: Remove
sphinx.util.inspect.isNewType
.
Patch by Adam Turner. -
Remove the long-deprecated (since Sphinx 2) alias
toVersionChange
in
sphinx.directives.other
(Deprecated since Sphinx 2).
Usesphinx.domains.changeset.VersionChange
directly.
Patch by Adam Turner.
Deprecated
- #12643: Renamed
sphinx.ext.intersphinx.normalize_intersphinx_mapping
tosphinx.ext.intersphinx.validate_intersphinx_mapping
.
The old name will be removed in Sphinx 10.
Patch by Adam Turner.
Full Changelog: v7.4.7...v8.0.0rc1