Update dependency sphinx to v5 - autoclosed
This MR contains the following updates:
Package | Change | Age | Adoption | Passing | Confidence |
---|---|---|---|---|---|
sphinx (changelog) |
~4.5 -> ~5.3
|
Release Notes
sphinx-doc/sphinx
v5.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
v5.2.3
=====================================
-
#10878: Fix base64 image embedding in
sphinx.ext.imgmath
-
#10886: Add
:nocontentsentry:
flag and global domain table of contents entry control option. Patch by Adam Turner
v5.2.2
=====================================
- #10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster.
v5.2.1
=====================================
Bugs fixed
-
#10861: Always normalise the
pycon3
lexer topycon
. - Fix using
sphinx.ext.autosummary
with modules containing titles in the module-level docstring.
v5.2.0
===========================================
- Recreated source tarballs for Debian maintainers.
v5.1.1
=====================================
Bugs fixed
-
#10701: Fix ValueError in the new
deque
basedsphinx.ext.napolean
iterator implementation. - #10702: Restore compatability with third-party builders.
v5.1.0
=====================================
Dependencies
-
#10656: Support
Docutils 0.19
_. Patch by Adam Turner.
.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05
Deprecated
-
#10467: Deprecated
sphinx.util.stemmer
in favour ofsnowballstemmer
. Patch by Adam Turner. -
#9856: Deprecated
sphinx.ext.napoleon.iterators
.
Features added
-
#10444: html theme: Allow specifying multiple CSS files through the
stylesheet
setting intheme.conf
or by settinghtml_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 ofexclude_patterns
. Patch by Adam Turner.
Bugs fixed
- #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)
- #10634: Make -P (pdb) option work better with exceptions triggered from events
-
#10550: py domain: Fix spurious whitespace in unparsing various operators (
+
,-
,~
, and**
). Patch by Adam Turner (refs: #10551). - #10460: logging: Always show node source locations as absolute paths.
- HTML Search: HTML tags are displayed as a part of object name
- HTML Search: search snipets should not be folded
- HTML Search: Minor errors are emitted on fetching search snipets
- HTML Search: The markers for header links are shown in the search result
-
#10520: HTML Theme: Fix use of sidebar classes in
agogo.css_t
. - #6679: HTML Theme: Fix inclusion of hidden toctrees in the agogo theme.
- #10566: HTML Theme: Fix enable_search_shortcuts does not work
- #8686: LaTeX: Text can fall out of code-block at end of page and leave artifact on next page
-
#10633: LaTeX: user injected
\color
commands in topic or admonition boxes may cause color leaks in PDF due to upstreamframed.sty <https://ctan.org/pkg/framed>
_ bug -
#10638: LaTeX: framed coloured boxes in highlighted code (e.g. highlighted
diffs using Pygments style
'manni'
) inherit thickness of code-block frame -
#10647: LaTeX: Only one
\label
is generated fordesc_signature
node even if it has multiple node IDs - #10579: i18n: UnboundLocalError is raised on translating raw directive
-
#9577, #10088: py domain: Fix warning for duplicate Python references when
using
:any:
and autodoc. - #10548: HTML Search: fix minor summary issues.
v5.0.2
=====================================
Features added
-
#10523: HTML Theme: Expose the Docutils's version info tuple as a template
variable,
docutils_version_info
. Patch by Adam Turner.
Bugs fixed
-
#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.
v5.0.1
=====================================
Bugs fixed
- #10498: gettext: TypeError is raised when sorting warning messages if a node has no line number. Patch by Adam Turner.
-
#10493: HTML Theme: :rst:dir:
topic
directive is rendered incorrectly with Docutils 0.18. Patch by Adam Turner. -
#10495: IndexError is raised for a :rst:role:
kbd
role having a separator. Patch by Adam Turner.
v5.0.0
=====================================
Dependencies
5.0.0 b1
-
#10164: Support
Docutils 0.18
_. Patch by Adam Turner.
.. _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26
Incompatible changes
5.0.0 b1
-
#10031: autosummary:
sphinx.ext.autosummary.import_by_name()
now raisesImportExceptionGroup
instead ofImportError
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 viagrouped_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 inconf.py
5.0.0 final
-
#10474: :confval:
language
does not acceptNone
as it value. The default value oflanguage
becomes to'en'
now. Patch by Adam Turner and Takeshi KOMIYA.
Deprecated
5.0.0 b1
-
#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
andunderscore.js
fromthe Sphinx repository
_ to yourstatic
directory, and add the following to yourlayout.html
:.. _the Sphinx repository: https://github.com/sphinx-doc/sphinx/tree/v5.3.0/sphinx/themes/basic/static .. code-block:: html+jinja
{%- block scripts %} {{ super() }} {%- endblock %}
Patch by Adam Turner.
-
setuptools integration. The
build_sphinx
sub-command for setup.py is marked as deprecated to follow the policy of setuptools team. -
The
locale
argument ofsphinx.util.i18n:babel_format_date()
becomes required -
The
language
argument ofsphinx.util.i18n:format_date()
becomes required -
sphinx.builders.html.html5_ready
-
sphinx.io.read_doc()
-
sphinx.util.docutils.__version_info__
-
sphinx.util.docutils.is_html5_writer_available()
-
sphinx.writers.latex.LaTeXWriter.docclasses
Features added
5.0.0 b1
-
#9075: autodoc: The default value of :confval:
autodoc_typehints_format
is changed to'smart'
. It will suppress the leading module names of typehints (ex.io.StringIO
->StringIO
). -
#8417: autodoc:
:inherited-members:
option now takes multiple classes. It allows to suppress inherited members of several classes on the module at once by specifying the option to :rst:dir:automodule
directive -
#9792: autodoc: Add new option for
autodoc_typehints_description_target
to include undocumented return values but not undocumented parameters. - #10285: autodoc: singledispatch functions having typehints are not documented
- autodoc: :confval:
autodoc_typehints_format
now also applies to attributes, data, properties, and type variable bounds. - #10258: autosummary: Recognize a documented attribute of a module as non-imported
-
#10028: Removed internal usages of JavaScript frameworks (jQuery and
underscore.js) and modernised
doctools.js
andsearchtools.js
to EMCAScript 2018. Patch by Adam Turner. -
#10302: C++, add support for conditional expressions (
?:
). -
#5157, #10251: Inline code is able to be highlighted via :rst:dir:
role
directive - #10337: Make sphinx-build faster by caching Publisher object during build. Patch by Adam Turner.
Bugs fixed
5.0.0 b1
- #10200: apidoc: Duplicated submodules are shown for modules having both .pyx and .so files. Patch by Adam Turner and Takeshi KOMIYA.
- #10279: autodoc: Default values for keyword only arguments in overloaded functions are rendered as a string literal
-
#10280: autodoc: :confval:
autodoc_docstring_signature
unexpectedly generates return value typehint for constructors if docstring has multiple signatures -
#10266: autodoc: :confval:
autodoc_preserve_defaults
does not work for mixture of keyword only arguments with/without defaults - #10310: autodoc: class methods are not documented when decorated with mocked function
-
#10305: autodoc: Failed to extract optional forward-ref'ed typehints correctly
via :confval:
autodoc_type_aliases
-
#10421: autodoc: :confval:
autodoc_preserve_defaults
doesn't work on class methods -
#10214: html: invalid language tag was generated if :confval:
language
contains a country code (ex. zh_CN) - #9974: html: Updated jQuery version from 3.5.1 to 3.6.0
- #10236: html search: objects are duplicated in search result
-
#9962: texinfo: Deprecation message for
@definfoenclose
command on bulding texinfo document - #10000: LaTeX: glossary terms with common definition are rendered with too much vertical whitespace
-
#10188: LaTeX: alternating multiply referred footnotes produce a
?
in pdf output -
#10363: LaTeX: make
'howto'
title page rule use\linewidth
for compatibility with usage of atwocolumn
class option -
#10318:
:prepend:
option of :rst:dir:literalinclude
directive does not work with:dedent:
option
5.0.0 final
-
#9575: autodoc: The annotation of return value should not be shown when
autodoc_typehints="description"
-
#9648: autodoc:
*args
and**kwargs
entries are duplicated whenautodoc_typehints="description"
- #8180: autodoc: Docstring metadata ignored for attributes
- #10443: epub: EPUB builder can't detect the mimetype of .webp file
- #10104: gettext: Duplicated locations are shown if 3rd party extension does not provide correct information
-
#10456: py domain:
:meta:
fields are displayed if docstring contains two or more meta-field - #9096: sphinx-build: the value of progress bar for paralle build is wrong
- #10110: sphinx-build: exit code is not changed when error is raised on builder-finished event
Configuration
-
If you want to rebase/retry this MR, click this checkbox.
This MR has been generated by Renovate Bot.