- update to 8.0.2
* #12633: Drop Python 3.9 support.
* Remove deprecated functions from sphinx.util:
+ Removed sphinx.util.path_stabilize (use sphinx.util.osutil.path_stabilize).
+ Removed sphinx.util.display_chunk (use sphinx.util.display.display_chunk).
+ Removed sphinx.util.status_iterator (use sphinx.util.display.status_iterator).
+ Removed sphinx.util.SkipProgressMessage (use
sphinx.util.display.SkipProgressMessage).
+ Removed sphinx.util.progress_message (use
sphinx.util.display.progress_message).
+ Removed sphinx.util.epoch_to_rfc1123 (use sphinx.http_date.epoch_to_rfc1123).
+ Removed sphinx.util.rfc1123_to_epoch (use sphinx.http_date.rfc1123_to_epoch).
+ Removed sphinx.util.save_traceback (use sphinx.exceptions.save_traceback).
+ Removed sphinx.util.format_exception_cut_frames (use
sphinx.exceptions.format_exception_cut_frames).
+ Removed sphinx.util.xmlname_checker (use
sphinx.builders.epub3._XML_NAME_PATTERN).
+ Removed sphinx.util.osutil.cd() (use contextlib.chdir()).
+ Removed sphinx.util.typing.stringify() (use
sphinx.util.typing.stringify_annotation()).
* #12593: Raise an error for invalid html_sidebars values.
* #12593: Raise an error in Theme.get_config() for invalid sections.
* #11693: Remove support for old-style Makefile and make.bat output in
sphinx-quickstart.
* #11693: Remove the --no-use-make-mode, -M, --use-make-mode, and -m options
from sphinx-quickstart.
* Removed the tuple interface to sphinx.ext.autodoc.ObjectMember.
* #12630: Sphinx 8 makes two changes to the linkcheck configuration defaults:
+ linkcheck_allow_unauthorized is now False by default.
+ linkcheck_report_timeouts_as_broken is now False by default.
* #12597: Change the default of show_warning_types from False to True.
* #12083: Remove support for the old (2008–2010) Sphinx 0.5 and Sphinx 0.6
intersphinx_mapping format.
* #12096: Do not overwrite user-supplied files when copying assets unless
forced with force=True.
* #12646: Remove sphinx.util.inspect.isNewType(). Use isinstance(obj,
typing.NewType) instead on Python 3.10 and newer.
* Remove the long-deprecated (since Sphinx 2) alias to VersionChange in
sphinx.directives.other (Deprecated since Sphinx 2). Use
sphinx.domains.changeset.VersionChange directly.
OBS-URL: https://build.opensuse.org/request/show/1198168
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=271
- update to 7.4.5:
* #12593, #12600: Revert coercing the type of selected
:confval:`html_sidebars` values to a list. Log an error
message when string values are detected. Patch by Adam
Turner.
* #12594: LaTeX: since 7.4.0, :rst:dir:`seealso` and other
"light" admonitions now break PDF builds if they contain a
:dudir:`figure` directive; and also if they are contained in
a table cell (rendered by tabulary). Patch by Jean-François
B.
* #12585, #12586: Do not warn when an intersphinx inventory
contains case-insensitively ambiguous duplicate items. Patch
by James Addison.
* #12582: Restore support for list-styled
:confval:`source_suffix` values with extensions that register
parsers. Patch by Adam Turner.
* #12580, #12583: Resolve failures with the C domain on
incremental builds with Sphinx 7.3.7 and earlier. Patch by
Adam Turner.
* Fix invalid HTML when a rubric node with invalid heading-
level is used. Patch by Adam Turner.
* #12579, #12581: Restore support for typing.ParamSpec in
autodoc. Patch by Adam Turner.
* #12555: Drop Docutils 0.18.1 and Docutils 0.19 support. Patch
by Adam Turner.
* LaTeX: the xcolor package is now required (but is for example
part of Ubuntu texlive-latex-recommended which has always
been required).
* LaTeX: the fontawesome5 LaTeX package is needed for the
default choices of icons now used in admonition titles in PDF
OBS-URL: https://build.opensuse.org/request/show/1188421
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=107
* #12593, #12600: Revert coercing the type of selected
:confval:`html_sidebars` values to a list. Log an error
message when string values are detected. Patch by Adam
Turner.
* #12594: LaTeX: since 7.4.0, :rst:dir:`seealso` and other
"light" admonitions now break PDF builds if they contain a
:dudir:`figure` directive; and also if they are contained in
a table cell (rendered by tabulary). Patch by Jean-François
B.
* #12585, #12586: Do not warn when an intersphinx inventory
contains case-insensitively ambiguous duplicate items. Patch
by James Addison.
* #12582: Restore support for list-styled
:confval:`source_suffix` values with extensions that register
parsers. Patch by Adam Turner.
* #12580, #12583: Resolve failures with the C domain on
incremental builds with Sphinx 7.3.7 and earlier. Patch by
Adam Turner.
* Fix invalid HTML when a rubric node with invalid heading-
level is used. Patch by Adam Turner.
* #12579, #12581: Restore support for typing.ParamSpec in
autodoc. Patch by Adam Turner.
* #12555: Drop Docutils 0.18.1 and Docutils 0.19 support. Patch
by Adam Turner.
* LaTeX: the xcolor package is now required (but is for example
part of Ubuntu texlive-latex-recommended which has always
been required).
* LaTeX: the fontawesome5 LaTeX package is needed for the
default choices of icons now used in admonition titles in PDF
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=268
- update to 7.3.7:
* #12299: Defer loading themes defined via entry points until
their explicit use by the user or a child theme. Patch by
Adam Turner.
* #12305: Return the default value for theme.get_config() with
an unsupported theme configuration section. Patch by Adam
Turner.
* #12295: Re-export all AST types in the C and C++ domains.
Patch by Adam Turner.
* #12295: Re-export various objects from
sphinx.domains.python._annotations in sphinx.domains.python.
Patch by Jacob Chesslo and Adam Turner.
* #12295: Re-export various objects from
sphinx.domains.python._object in sphinx.domains.python. Patch
by Jacob Chesslo and Adam Turner.
* Handle cases when Any is not an instance of type. Patch by
Adam Turner.
* #12290: Fix a false-positive warning when setting a
configuration value with Any as the valid type to a type
other than the value's default. Patch by Adam Turner.
* Preload all themes defined via entry points. Patch by Adam
Turner.
* Fix a bad interaction between the 'Furo' theme and the new-
style for configuration values. Patch by Adam Turner.
* Require tomli on Python 3.10 and earlier. Patch by Adam
Turner.
* #11858: Increase the minimum supported version of Alabaster
to 0.7.14. Patch by Adam Turner.
* #11411: Support Docutils 0.21. Patch by Adam Turner.
* #12012: Use types-docutils instead of docutils-stubs.
OBS-URL: https://build.opensuse.org/request/show/1184035
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=106
* #12299: Defer loading themes defined via entry points until
their explicit use by the user or a child theme. Patch by
Adam Turner.
* #12305: Return the default value for theme.get_config() with
an unsupported theme configuration section. Patch by Adam
Turner.
* #12295: Re-export all AST types in the C and C++ domains.
Patch by Adam Turner.
* #12295: Re-export various objects from
sphinx.domains.python._annotations in sphinx.domains.python.
Patch by Jacob Chesslo and Adam Turner.
* #12295: Re-export various objects from
sphinx.domains.python._object in sphinx.domains.python. Patch
by Jacob Chesslo and Adam Turner.
* Handle cases when Any is not an instance of type. Patch by
Adam Turner.
* #12290: Fix a false-positive warning when setting a
configuration value with Any as the valid type to a type
other than the value's default. Patch by Adam Turner.
* Preload all themes defined via entry points. Patch by Adam
Turner.
* Fix a bad interaction between the 'Furo' theme and the new-
style for configuration values. Patch by Adam Turner.
* Require tomli on Python 3.10 and earlier. Patch by Adam
Turner.
* #11858: Increase the minimum supported version of Alabaster
to 0.7.14. Patch by Adam Turner.
* #11411: Support Docutils 0.21. Patch by Adam Turner.
* #12012: Use types-docutils instead of docutils-stubs.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=264
- update to 7.2.6:
* #11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES`
environment variable, which if set reloads modules when
using autodoc with ``TYPE_CHECKING = True``.
* #11679: Use :py:func:`importlib.reload` to reload modules in
autodoc.
* autodoc: Support positional-only parameters in classmethod methods
* Restore support string methods on path objects. This is deprecated
and will be removed in Sphinx 8. Use os.fspath() to convert Path
* linkcheck: Resolve hanging tests for timezones west of London and
* Add the :no-typesetting: option to suppress textual output and only
* Restored the the str interface of the asset classes (_CascadingStyleSheet
and _JavaScript), which several extensions relied upon. This will be
variables/structure members
* html: HTML logo or Favicon specified as file not being found on output
* #8959: using UNIX path separator in image directive confuses Sphinx on Windows
bracketed, not braced (and is anyhow not needed)
- Add sphinx-pr8520-fix-AliasNode-copy.patch to fix failing
- add sphinx-pygments-compat.patch (fix tests with newer pygments)
module has submodules
- Recommends only on SUSE
- Move sphinxcontrib namespace into seperate package to avoid
- Split latex-related stuff into its own subpackage so we can
- Be explicit about six version requirements
anymore. If you want to keep italic style, adapt your stylesheet.
figure numbers instead # symbol.
unused_docs have been removed.
font. Custom writers will have to be adapted to handle this node.
lineno-match option. Thanks to Jeppe Pihl.
OBS-URL: https://build.opensuse.org/request/show/1111065
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=101
* #11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES`
environment variable, which if set reloads modules when
using autodoc with ``TYPE_CHECKING = True``.
* #11679: Use :py:func:`importlib.reload` to reload modules in
autodoc.
* autodoc: Support positional-only parameters in classmethod methods
* Restore support string methods on path objects. This is deprecated
and will be removed in Sphinx 8. Use os.fspath() to convert Path
* linkcheck: Resolve hanging tests for timezones west of London and
* Add the :no-typesetting: option to suppress textual output and only
* Restored the the str interface of the asset classes (_CascadingStyleSheet
and _JavaScript), which several extensions relied upon. This will be
variables/structure members
* html: HTML logo or Favicon specified as file not being found on output
* #8959: using UNIX path separator in image directive confuses Sphinx on Windows
bracketed, not braced (and is anyhow not needed)
- Add sphinx-pr8520-fix-AliasNode-copy.patch to fix failing
- add sphinx-pygments-compat.patch (fix tests with newer pygments)
module has submodules
- Recommends only on SUSE
- Move sphinxcontrib namespace into seperate package to avoid
- Split latex-related stuff into its own subpackage so we can
- Be explicit about six version requirements
anymore. If you want to keep italic style, adapt your stylesheet.
figure numbers instead # symbol.
unused_docs have been removed.
font. Custom writers will have to be adapted to handle this node.
lineno-match option. Thanks to Jeppe Pihl.
- Add sphinx-setup_command_unicode.patch: Backport of
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=253
- update to 7.2.5:
* #11645: Fix a regression preventing autodoc from importing
modules within packages that make use of
``if typing.TYPE_CHECKING:`` to guard circular imports
needed by type checkers.
* #11634: Fixed inheritance diagram relative link resolution
for sibling files in a subdirectory.
* #11659: Allow ``?config=...`` in :confval:`mathjax_path`.
* #11654: autodoc: Fail with a more descriptive error message
when an object claims to be an instance of ``type``,
but is not a class.
* 11620: Cease emitting :event:`source-read` events for files
read via the :dudir:`include` directive.
* 11620: Add a new :event:`include-read` for observing and
transforming the content of included files via the :dudir:`include`
directive.
* #11627: Restore support for copyright lines of the form
``YYYY`` when ``SOURCE_DATE_EPOCH`` is set.
OBS-URL: https://build.opensuse.org/request/show/1109692
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=100
* #11645: Fix a regression preventing autodoc from importing
modules within packages that make use of
``if typing.TYPE_CHECKING:`` to guard circular imports
needed by type checkers.
* #11634: Fixed inheritance diagram relative link resolution
for sibling files in a subdirectory.
* #11659: Allow ``?config=...`` in :confval:`mathjax_path`.
* #11654: autodoc: Fail with a more descriptive error message
when an object claims to be an instance of ``type``,
but is not a class.
* 11620: Cease emitting :event:`source-read` events for files
read via the :dudir:`include` directive.
* 11620: Add a new :event:`include-read` for observing and
transforming the content of included files via the :dudir:`include`
directive.
* #11627: Restore support for copyright lines of the form
``YYYY`` when ``SOURCE_DATE_EPOCH`` is set.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=251
- update to 7.2.4
* Require sphinxcontrib-serializinghtml 1.1.9.
* Fix regression in autodoc.Documenter.parse_name().
* Fix regression in JSON serialisation.
* autodoc: Support positional-only parameters in classmethod methods
when autodoc_preserve_defaults is True.
* Restore support string methods on path objects. This is deprecated
and will be removed in Sphinx 8. Use os.fspath() to convert Path
objects to strings, or Path’s methods to work with path objects.
* Fix a regression in the MoveModuleTargets transform.
* linkcheck: Resolve hanging tests for timezones west of London and
incorrect conversion from UTC to offsets from the UNIX epoch.
- update to 7.2.2
* Drop Python 3.8 support.
* Require Pygments 2.14 or later.
* Deprecate sphinx.util.md5 and sphinx.util.sha1. Use hashlib instead.
* Deprecate sphinx.testing.path. Use os.path or pathlib instead.
* Support os.PathLike types and pathlib.Path objects in many more places.
* Add the :no-typesetting: option to suppress textual output and only
create a linkable anchor.
* Allow running Sphinx with python -m sphinx build
* graphviz: Fix relative links from within the graph.
* pytest: Fail tests on “XPASS”, Set PYTHONWARNINGS=error, set strict config
* Restored the the str interface of the asset classes (_CascadingStyleSheet
and _JavaScript), which several extensions relied upon. This will be
removed in Sphinx 9.
* Many more changes (even deprecations), see upstream changelog
- update to 7.1.2:
* #11542: linkcheck: Properly respect :confval:`linkcheck_anchors`
and do not spuriously report failures to validate anchors.
- Update to 7.1.1:
* #11514: Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer.
Patch by Bénédikt Tran.
- Update to 7.1.0:
* Releases are no longer signed, given the `change in PyPI policy`_.
* #11412: Emit warnings on using a deprecated Python-specific index entry type
(namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``,
``statement``, and ``builtin``) in the :rst:dir:`index` directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.
* #11415: Add a checksum to JavaScript and CSS asset URIs included within
generated HTML, using the CRC32 algorithm.
* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version
requirement to be specified as ``(major, minor)``.
* #11011: Allow configuring a line-length limit for object signatures, via
:confval:`maximum_signature_line_length` and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:`py:function:single-line-parameter-list`.
Patch by Thomas Louf, Adam Turner, and Jean-François B.
* #10983: Support for multiline copyright statements in the footer block.
Patch by Stefanie Molin
* ``sphinx.util.display.status_iterator`` now clears the current line
with ANSI control codes, rather than overprinting with space characters.
* #11431: linkcheck: Treat SSL failures as broken links.
Patch by Bénédikt Tran
* #11157: Keep the ``translated`` attribute on translated nodes.
* #11451: Improve the traceback displayed when using :option:`sphinx-build -T`
in parallel builds. Patch by Bénédikt Tran
* #11324: linkcheck: Use session-basd HTTP requests.
* #11438: Add support for the :rst:dir:`py:class` and :rst:dir:`py:function`
directives for PEP 695 (generic classes and functions declarations) and
PEP 696 (default type parameters). Multi-line support (#11011) is enabled
for type parameters list and can be locally controlled on object description
directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`.
Patch by Bénédikt Tran.
* #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis
via :confval:`linkcheck_anchors_ignore_for_url` while
still checking the validity of the page itself.
Patch by Bénédikt Tran
* #1246: Add translation progress statistics and inspection support,
via a new substitution (``|translation progress|``) and a new
configuration variable (:confval:`translation_progress_classes`).
These enable determining the percentage of translated elements within
a document, and the remaining translated and untranslated elements.
* Restored the ``footnote-reference`` class that has been removed in
the latest (unreleased) version of Docutils.
* #11486: Use :rfc:`8081` font file MIME types in the EPUB builder.
Using the correct MIME type will prevent warnings from ``epubcheck``
and will generate a valid EPUB.
* #11435: Use microsecond-resolution timestamps for outdated file detection
in ``BuildEnvironment.get_outdated_files``.
* #11437: Top-level headings starting with a reStructuredText role
now render properly when :confval:`rst_prolog` is set.
Previously, a file starting with the below would have
improperly rendered due to where the prologue text
was inserted into the document.
Patch by Bénédikt Tran.
* #11337: Fix a ``MemoryError`` in ``sphinx.ext.intersphinx`` when using ``None``
or ``typing.*`` as inline type references. Patch by Bénédikt Tran (picnixz)
* #11345: Always delete ``docutils.conf`` in test directories when running
``SphinxTestApp.cleanup()``.
OBS-URL: https://build.opensuse.org/request/show/1108105
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=99
- update to 7.2.4
* Require sphinxcontrib-serializinghtml 1.1.9.
* Fix regression in autodoc.Documenter.parse_name().
* Fix regression in JSON serialisation.
* autodoc: Support positional-only parameters in classmethod methods
when autodoc_preserve_defaults is True.
* Restore support string methods on path objects. This is deprecated
and will be removed in Sphinx 8. Use os.fspath() to convert Path
objects to strings, or Path’s methods to work with path objects.
* Fix a regression in the MoveModuleTargets transform.
* linkcheck: Resolve hanging tests for timezones west of London and
incorrect conversion from UTC to offsets from the UNIX epoch.
OBS-URL: https://build.opensuse.org/request/show/1108097
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=248
- update to 7.2.2
* Drop Python 3.8 support.
* Require Pygments 2.14 or later.
* Deprecate sphinx.util.md5 and sphinx.util.sha1. Use hashlib instead.
* Deprecate sphinx.testing.path. Use os.path or pathlib instead.
* Support os.PathLike types and pathlib.Path objects in many more places.
* Add the :no-typesetting: option to suppress textual output and only
create a linkable anchor.
* Allow running Sphinx with python -m sphinx build
* graphviz: Fix relative links from within the graph.
* pytest: Fail tests on “XPASS”, Set PYTHONWARNINGS=error, set strict config
* Restored the the str interface of the asset classes (_CascadingStyleSheet
and _JavaScript), which several extensions relied upon. This will be
removed in Sphinx 9.
* Many more changes (even deprecations), see upstream changelog
OBS-URL: https://build.opensuse.org/request/show/1105478
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=247
- Update to 7.1.1:
* #11514: Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer.
Patch by Bénédikt Tran.
- Update to 7.1.0:
* Releases are no longer signed, given the `change in PyPI policy`_.
* #11412: Emit warnings on using a deprecated Python-specific index entry type
(namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``,
``statement``, and ``builtin``) in the :rst:dir:`index` directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.
* #11415: Add a checksum to JavaScript and CSS asset URIs included within
generated HTML, using the CRC32 algorithm.
* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version
requirement to be specified as ``(major, minor)``.
* #11011: Allow configuring a line-length limit for object signatures, via
:confval:`maximum_signature_line_length` and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:`py:function:single-line-parameter-list`.
Patch by Thomas Louf, Adam Turner, and Jean-François B.
* #10983: Support for multiline copyright statements in the footer block.
Patch by Stefanie Molin
* ``sphinx.util.display.status_iterator`` now clears the current line
with ANSI control codes, rather than overprinting with space characters.
* #11431: linkcheck: Treat SSL failures as broken links.
Patch by Bénédikt Tran
* #11157: Keep the ``translated`` attribute on translated nodes.
* #11451: Improve the traceback displayed when using :option:`sphinx-build -T`
in parallel builds. Patch by Bénédikt Tran
* #11324: linkcheck: Use session-basd HTTP requests.
OBS-URL: https://build.opensuse.org/request/show/1101202
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=245
- Bump to version 6.2.0
* Require Docutils 0.18.1 or greater.
* LaTeX: removal of some internal TeX ``\dimen`` registers (not previously
publicly documented) as per 5.1.0 code comments in ``sphinx.sty``:
``\sphinxverbatimsep``, ``\sphinxverbatimborder``, ``\sphinxshadowsep``,
``\sphinxshadowsize``, and ``\sphinxshadowrule``. (refs: #11105)
* Remove ``.egg`` support from pycode ``ModuleAnalyser``; Python eggs are a
now-obsolete binary distribution format
* #11089: Remove deprecated code in ``sphinx.builders.linkcheck``.
Patch by Daniel Eades
* Remove internal-only ``sphinx.locale.setlocale``
* #11247: Deprecate the legacy ``intersphinx_mapping`` format
* ``sphinx.util.osutil.cd`` is deprecated in favour of ``contextlib.chdir``.
* #11277: :rst:dir:`autoproperty` allows the return type to be specified as
a type comment (e.g., ``# type: () -> int``). Patch by Bénédikt Tran
* #10811: Autosummary: extend ``__all__`` to imported members for template rendering
when option ``autosummary_ignore_module_all`` is set to ``False``. Patch by
Clement Pinard
* #11147: Add a ``content_offset`` parameter to ``nested_parse_with_titles()``,
allowing for correct line numbers during nested parsing.
Patch by Jeremy Maitin-Shepard
* Update to Unicode CLDR 42
* Add a ``--jobs`` synonym for ``-j``. Patch by Hugo van Kemenade
* LaTeX: a command ``\sphinxbox`` for styling text elements with a (possibly
rounded) box, optional background color and shadow, has been added.
See :ref:`sphinxbox`. (refs: #11224)
* LaTeX: add ``\sphinxstylenotetitle``, ..., ``\sphinxstylewarningtitle``, ...,
for an extra layer of mark-up freeing up ``\sphinxstrong`` for other uses.
See :ref:`latex-macros`. (refs: #11267)
* LaTeX: :dudir:`note`, :dudir:`hint`, :dudir:`important` and :dudir:`tip` can
OBS-URL: https://build.opensuse.org/request/show/1082382
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=236
- Update to version 6.1.2
* #11101: LaTeX: div.topic_padding key of sphinxsetup documented at 5.1.0 was
implemented with name topic_padding
* #11099: LaTeX: shadowrule key of sphinxsetup causes PDF build to crash since
Sphinx 5.1.0
* #11096: LaTeX: shadowsize key of sphinxsetup causes PDF build to crash since
Sphinx 5.1.0
* #11095: LaTeX: shadow of topic and contents boxes not in page margin since
Sphinx 5.1.0
* #11100: Fix copying images when running under parallel mode.
- Disable test_copy_images tests as they need an internet access.
OBS-URL: https://build.opensuse.org/request/show/1056898
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=228
- Update to version 6.1.1
* #11091: Fix ``util.nodes.apply_source_workaround`` for ``literal_block`` nodes
with no source information in the node or the node's parents.
* Adopted the `Ruff`_ code linter.
.. _Ruff: https://github.com/charliermarsh/ruff
* #10979: gettext: Removed support for pluralisation in ``get_translation``.
This was unused and complicated other changes to ``sphinx.locale``.
* ``sphinx.util`` functions:
* Renamed ``sphinx.util.typing.stringify()``
to ``sphinx.util.typing.stringify_annotation()``
* Moved ``sphinx.util.xmlname_checker()``
to ``sphinx.builders.epub3._XML_NAME_PATTERN``
Moved to ``sphinx.util.display``:
* ``sphinx.util.status_iterator``
* ``sphinx.util.display_chunk``
* ``sphinx.util.SkipProgressMessage``
* ``sphinx.util.progress_message``
Moved to ``sphinx.util.http_date``:
* ``sphinx.util.epoch_to_rfc1123``
* ``sphinx.util.rfc1123_to_epoch``
Moved to ``sphinx.util.exceptions``:
* ``sphinx.util.save_traceback``
* ``sphinx.util.format_exception_cut_frames``
* Cache doctrees in the build environment during the writing phase.
* Make all writing phase tasks support parallel execution.
* #11072: Use PEP 604 (``X | Y``) display conventions for ``typing.Optional``
and ``typing.Optional`` types within the Python domain and autodoc.
* #10700: autodoc: Document ``typing.NewType()`` types as classes rather than
'data'.
* Cache doctrees between the reading and writing phases.
OBS-URL: https://build.opensuse.org/request/show/1056250
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=227
- Update to version 6.0.0
* #10468: Drop Python 3.6 support
* #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and
Docutils 0.17 support. Patch by Adam Turner
* #7405: Removed the jQuery and underscore.js JavaScript frameworks.
These frameworks are no longer be automatically injected into themes from
Sphinx 6.0. If you develop a theme or extension that uses the
``jQuery``, ``$``, or ``$u`` global objects, you need to update your
JavaScript to modern standards, or use the mitigation below.
The first option is to use the sphinxcontrib.jquery_ extension, which has been
developed by the Sphinx team and contributors. To use this, add
``sphinxcontrib.jquery`` to the ``extensions`` list in ``conf.py``, or call
``app.setup_extension("sphinxcontrib.jquery")`` if you develop a Sphinx theme
or extension.
The second option is to manually ensure that the frameworks are present.
To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and
``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory,
and add the following to your ``layout.html``:
.. code-block:: html+jinja
{%- block scripts %}
<script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>
<script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
{{ super() }}
{%- endblock %}
.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
Patch by Adam Turner.
* #10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See
:ref:`dev-deprecated-apis` for details. Patch by Adam Turner.
* #10901: C Domain: Remove support for parsing pre-v3 style type directives and
roles. Also remove associated configuration variables ``c_allow_pre_v3`` and
OBS-URL: https://build.opensuse.org/request/show/1045890
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=224
