v8.0.2: Sphinx 8.0.2

Compare Source

Changelog:https://www.sphinx-doc.org/en/master/changes.html

v8.0.1: Sphinx 8.0.1

Compare Source

Changelog:https://www.sphinx-doc.org/en/master/changes.html

v8.0.0: Sphinx 8.0.0

Compare Source

Changelog:https://www.sphinx-doc.org/en/master/changes.html

Dependencies

• #​12633: Drop Python 3.9 support.

Incompatible changes

• Remove deprecated functions fromsphinx.util:

  • Removedsphinx.util.path_stabilize
    (usesphinx.util.osutil.path_stabilize).
  • Removedsphinx.util.display_chunk
    (usesphinx.util.display.display_chunk).
  • Removedsphinx.util.status_iterator
    (usesphinx.util.display.status_iterator).
  • Removedsphinx.util.SkipProgressMessage
    (usesphinx.util.display.SkipProgressMessage).
  • Removedsphinx.util.progress_message
    (usesphinx.util.display.progress_message).
  • Removedsphinx.util.epoch_to_rfc1123
    (usesphinx.http_date.epoch_to_rfc1123).
  • Removedsphinx.util.rfc1123_to_epoch
    (usesphinx.http_date.rfc1123_to_epoch).
  • Removedsphinx.util.save_traceback
    (usesphinx.exceptions.save_traceback).
  • Removedsphinx.util.format_exception_cut_frames
    (usesphinx.exceptions.format_exception_cut_frames).
  • Removedsphinx.util.xmlname_checker
    (usesphinx.builders.epub3._XML_NAME_PATTERN).

  Patch by Adam Turner.

• Removedsphinx.util.osutil.cd
  (usecontextlib.chdir).
  Patch by Adam Turner.

• Removedsphinx.util.typing.stringify
  (usesphinx.util.typing.stringify_annotation).
  Patch by Adam Turner.

• #​12593: Raise an error for invalidhtml_sidebars values.
  Patch by Adam Turner.

• #​12593: Raise an error inTheme.get_config for invalid sections.
  Patch by Adam Turner.

• #​11693: Remove support for old-styleMakefile 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 tosphinx.ext.autodoc.ObjectMember.
  Patch by Adam Turner.

• #​12630: Sphinx 8 makes two changes to thelinkcheck 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 ofshow_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.

• #​12646: Removesphinx.util.inspect.isNewType.
  Useisinstance(obj, typing.NewType) instead on Python 3.10 and newer.
  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: Renamedsphinx.ext.intersphinx.normalize_intersphinx_mapping
  tosphinx.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.
  Useos.fspath to convert :py:class:~pathlib.Path objects to strings,
  orpathlib.Path's methods to work with path objects.
  Patch by Adam Turner.