- Update to 8.2.3
* Correct spelling of highlighting_failure in warning sub-type.
* Restore support for using sphinx.testing.path paths with
sphinx.testing.fixtures
* viewcode: Fix importing modules more than once.
* Fix argument type for jieba.load_userdict().
* Add workaround for nbsphinx implicit imports.
* Ensure inline <script/> tags are written exactly once.
* Define _StrPath.__radd__().
* Fix _CurrentDocument membership testing with parent_symbol.
OBS-URL: https://build.opensuse.org/request/show/1253092
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=281
* #13000: Drop Python 3.10 support.
* #13044: Remove the internal and undocumented has_equations
data from the :py:class:`!MathDomain` domain. The
undocumented :py:meth:`!MathDomain.has_equations` method now
unconditionally returns True. These are replaced by the
has_maths_elements key of the page context dict. Patch by
Adam Turner.
* #13227: HTML output for sequences of keys in the
:rst:role:`kbd` role no longer uses a <kbd class="kbd
compound"> element to wrap the keys and separators, but
places them directly in the relevant parent node. This means
that CSS rulesets targeting kbd.compound or .kbd.compound
will no longer have any effect. Patch by Adam Turner.
* #13037: Deprecate the SingleHTMLBuilder.fix_refuris method.
Patch by James Addison.
* #13083, #13330: Un-deprecate sphinx.util.import_object. Patch
by Matthias Geier.
* #13173: Add a new duplicate_declaration warning type, with
duplicate_declaration.c and duplicate_declaration.cpp
subtypes. Patch by Julien Lecomte and Adam Turner.
* #11824: linkcode: Allow extensions to add support for a
domain by defining the keys that should be present. Patch by
Nicolas Peugnet.
* #13144: Add a class option to the :rst:dir:`autosummary`
directive. Patch by Tim Hoffmann.
* #13146: Napoleon: Unify the type preprocessing logic to allow
Google-style docstrings to use the optional and default
keywords. Patch by Chris Barrick.
* #13227: Implement the :rst:role:`kbd` role as a SphinxRole.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=278
* #13013: Restore support for :func:`!cut_lines` with no object
type. Patch by Adam Turner.
* #13012: Expose :exc:`sphinx.errors.ExtensionError` in
sphinx.util for backwards compatibility. This will be removed
in Sphinx 9, as exposing the exception in sphinx.util was
never intentional. :exc:`!ExtensionError` has been part of
sphinx.errors since Sphinx 0.9. Patch by Adam Turner.
* #13006: Use the preferred https://www.cve.org/ URL for the
:rst:role:`:cve: <cve>` role. Patch by Hugo van Kemenade.
* #13007: LaTeX: Improve resiliency when the required
fontawesome or fontawesome5 packages are not installed. Patch
by Jean-François B.
* #12756: Add lower-bounds to the sphinxcontrib-* dependencies.
Patch by Adam Turner.
* #12833: Update the LaTeX parskip package from 2001 to 2018.
Patch by Jean-François B.
* #12763: Remove unused internal class sphinx.util.Tee. Patch
by Adam Turner.
* #12822: LaTeX: for Unicode engines, the :ref:`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.
* #12875: Disable smartquotes for languages: zh_CN and zh_TW by
default. Patch by A. Rafey Khan.
* #12762: Deprecate sphinx.util.import_object. Use
:py:func:`importlib.import_module` instead. Patch by Adam
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=273
- 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
* #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
* #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
* #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
* #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.
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
- Update to version 5.3.0
* #10759: LaTeX: add :confval:`latex_table_style` and support the
``'booktabs'``, ``'borderless'``, and ``'colorrows'`` styles.
(thanks to Stefan Wiehler for initial pull requests #6666, #6671)
* #10840: One can cross-reference including an option value like ``:option:`--module=foobar```,
``:option:`--module[=foobar]``` or ``:option:`--module foobar```.
Patch by Martin Liska.
* #10881: autosectionlabel: Record the generated section label to the debug log.
* #10268: Correctly URI-escape image filenames.
* #10887: domains: Allow sections in all the content of all object description
directives (e.g. :rst:dir:`py:function`). Patch by Adam Turner
OBS-URL: https://build.opensuse.org/request/show/1011246
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=222
- Update to version 5.2.2
* #10872: Restore link targets for autodoc modules to the top of content.
Patch by Dominic Davis-Foster.
- Update to version 5.2.1
* #10861: Always normalise the ``pycon3`` lexer to ``pycon``.
* Fix using ``sphinx.ext.autosummary`` with modules containing titles in the
module-level docstring.
- Remove unneeded spec hunks.
- Update to version 5.2.0
* #10356: Sphinx now uses declarative metadata with pyproject.toml to create packages,
using PyPA’s build project as a build backend. Patch by Adam Turner.
* #10286: C++, support requires clauses not just between the template parameter lists and the declaration.
* #10755: linkcheck: Check the source URL of raw directives that use the url option.
* #10781: Allow ref role to be used with definitions and fields.
* #10717: HTML Search: Increase priority for full title and subtitle matches in search results
* #10718: HTML Search: Save search result score to the HTML element for debugging
* #10673: Make toctree accept ‘genindex’, ‘modindex’ and ‘search’ docnames
* #6316, #10804: Add domain objects to the table of contents. Patch by Adam Turner
* #6692: HTML Search: Include explicit index directive index entries in the search index and search results. Patch by Adam Turner
* #10816: imgmath: Allow embedding images in HTML as base64
* #10257: C++, ensure consistent non-specialization template argument representation.
* #10729: C++, fix parsing of certain non-type template parameter packs.
* #10715: Revert #10520: “Fix” use of sidebar classes in agogo.css_t
* #10701: Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean``
iterator implementation.
* #10702: Restore compatability with third-party builders.
OBS-URL: https://build.opensuse.org/request/show/1006671
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=218
- Update to version 5.1.0
* #10656: Support `Docutils 0.19`_. Patch by Adam Turner.
* #10467: Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``.
Patch by Adam Turner.
* #9856: Deprecated ``sphinx.ext.napoleon.iterators``.
* #10444: html theme: Allow specifying multiple CSS files through the ``stylesheet``
setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings.
* #10366: std domain: Add support for emphasising placeholders in :rst:dir:`option`
directives through a new :confval:`option_emphasise_placeholders` configuration
option.
* #10439: std domain: Use the repr of some variables when displaying warnings,
making whitespace issues easier to identify.
* #10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by
Pradyun Gedam.
* #10648: LaTeX: CSS-named-alike additional :ref:`'sphinxsetup' <latexsphinxsetup>`
keys allow to configure four separate border-widths, four paddings, four
corner radii, a shadow (possibly inset), colours for border, background, shadow
for each of the code-block, topic, attention, caution, danger, error and warning
directives.
* #10655: LaTeX: Explain non-standard encoding in LatinRules.xdy
* #10599: HTML Theme: Wrap consecutive footnotes in an ``<aside>`` element when
using Docutils 0.18 or later, to allow for easier styling. This matches the
behaviour introduced in Docutils 0.19. Patch by Adam Turner.
* #10518: config: Add ``include_patterns`` as the opposite of ``exclude_patterns``.
Patch by Adam Turner.
* #10594: HTML Theme: field term colons are doubled if using Docutils 0.18+
* #10596: Build failure if Docutils version is 0.18 (not 0.18.1) due
to missing ``Node.findall()``
* #10506: LaTeX: build error if highlighting inline code role in figure caption
(refs: #10251)
OBS-URL: https://build.opensuse.org/request/show/991054
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=214
- Update to version 5.0.2
* #10523: HTML Theme: Expose the Docutils's version info tuple as a template
variable, ``docutils_version_info``. Patch by Adam Turner.
* #10538: autodoc: Inherited class attribute having docstring is documented even
if :confval:`autodoc_inherit_docstring` is disabled
* #10509: autosummary: autosummary fails with a shared library
* #10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.
* #10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+.
Patch by Adam Turner.
* #10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.
OBS-URL: https://build.opensuse.org/request/show/983449
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=210
- Update to version 5.0.0:
* #10164: Support `Docutils 0.18`_. Patch by Adam Turner.
* #10031: autosummary: ``sphinx.ext.autosummary.import_by_name()`` now raises
``ImportExceptionGroup`` instead of ``ImportError`` when it failed to import
target object. Please handle the exception if your extension uses the
function to import Python object. As a workaround, you can disable the
behavior via ``grouped_exception=False`` keyword argument until v7.0.
* #9962: texinfo: Customizing styles of emphasized text via ``@definfoenclose``
command was not supported because the command was deprecated since texinfo 6.8
* #2068: :confval:`intersphinx_disabled_reftypes` has changed default value
from an empty list to ``['std:doc']`` as avoid too surprising silent
intersphinx resolutions.
To migrate: either add an explicit inventory name to the references
intersphinx should resolve, or explicitly set the value of this configuration
variable to an empty list.
* #10197: html theme: Reduce ``body_min_width`` setting in basic theme to 360px
* #9999: LaTeX: separate terms from their definitions by a CR (refs: #9985)
* #10062: Change the default language to ``'en'`` if any language is not set in
``conf.py``
* #10474: :confval:`language` does not accept ``None`` as it value. The default
value of ``language`` becomes to ``'en'`` now.
* #10028: jQuery and underscore.js will 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 or use the mitigation below.
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``:
.. _the Sphinx repository: https://github.com/sphinx-doc/sphinx/tree/v4.3.2/sphinx/themes/basic/static
.. code-block:: html+jinja
OBS-URL: https://build.opensuse.org/request/show/979826
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=208
- Update to version 4.5.0:
* #10112: extlinks: Disable hardcoded links detector by default
* #9993, #10177: std domain: Disallow to refer an inline target via
:rst:role:`ref` role
* ``sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()``
* #10260: Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring
* #10234: autosummary: Add "autosummary" CSS class to summary tables
* #10125: extlinks: Improve suggestion message for a reference having title
* #10112: extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable
hardcoded links detector feature
* #9494, #9456: html search: Add a config variable
:confval:`html_show_search_summary` to enable/disable the search summaries
* #9337: HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:'/' as
a Quick search shortcut and :kbd:`Esc` shortcut that
removes search highlighting.
* #10107: i18n: Allow to suppress translation warnings by adding ``#noqa``
comment to the tail of each translation message
* #10252: C++, support attributes on classes, unions, and enums.
* #10253: :rst:dir:`pep` role now generates URLs based on peps.python.org
* #9876: autodoc: Failed to document an imported class that is built from native
binary module
* #10133: autodoc: Crashed when mocked module is used for type annotation
* #10146: autodoc: :confval:`autodoc_default_options` does not support
``no-value`` option
* #9971: autodoc: TypeError is raised when the target object is annotated by
unhashable object
* #10205: extlinks: Failed to compile regexp on checking hardcoded links
* #10277: html search: Could not search short words (ex. "use")
* #9529: LaTeX: named auto numbered footnote (ex. ``[#named]``) that is referred
multiple times was rendered to a question mark
OBS-URL: https://build.opensuse.org/request/show/965338
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=206
- Update to version 4.4.0:
* #10007: Use ``importlib_metadata`` for python-3.9 or older
* #10007: Drop ``setuptools``
* #9075: autodoc: Add a config variable :confval:`autodoc_typehints_format`
to suppress the leading module names of typehints of function signatures (ex.
``io.StringIO`` -> ``StringIO``)
* #9831: Autosummary now documents only the members specified in a module's
``__all__`` attribute if :confval:`autosummary_ignore_module_all` is set to
``False``. The default behaviour is unchanged. Autogen also now supports
this behavior with the ``--respect-module-all`` switch.
* #9555: autosummary: Improve error messages on failure to load target object
* #9800: extlinks: Emit warning if a hardcoded link is replaceable
by an extlink, suggesting a replacement.
* #9961: html: Support nested <kbd> HTML elements in other HTML builders
* #10013: html: Allow to change the loading method of JS via ``loading_method``
parameter for :meth:`Sphinx.add_js_file()`
* #9551: html search: "Hide Search Matches" link removes "highlight" parameter
from URL
* #9815: html theme: Wrap sidebar components in div to allow customizing their
layout via CSS
* #9827: i18n: Sort items in glossary by translated terms
* #9899: py domain: Allows to specify cross-reference specifier (``.`` and
``~``) as ``:type:`` option
* #9894: linkcheck: add option ``linkcheck_exclude_documents`` to disable link
checking in matched documents.
* #9793: sphinx-build: Allow to use the parallel build feature in macOS on macOS
and Python3.8+
* #10055: sphinx-build: Create directories when ``-w`` option given
* #9993: std domain: Allow to refer an inline target (ex. ``_`target name```)
via :rst:role:`ref` role
OBS-URL: https://build.opensuse.org/request/show/947122
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=200
