fix(deps): update dependency sphinx to v5 #18
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
force-pushed
the
renovate/sphinx-5.x
branch
from
204e32f to
2e15d62
Compare
renovate
bot
force-pushed
the
renovate/sphinx-5.x
branch
from
2e15d62 to
efb6d40
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^4.5.0->^5.0.0Release Notes
sphinx-doc/sphinx
v5.3.0Compare Source
=====================================
latex_table_styleand support the'booktabs','borderless', and'colorrows'styles.(thanks to Stefan Wiehler for initial pull requests #6666, #6671)
:option:`--module=foobar```,:option:--module[=foobar]``` or ``:option:--module foobar```.Patch by Martin Liska.
directives (e.g. :rst:dir:
py:function). Patch by Adam Turnerv5.2.3Compare Source
=====================================
sphinx.ext.imgmath:nocontentsentry:flag and global domain table of contentsentry control option. Patch by Adam Turner
v5.2.2Compare Source
=====================================
Patch by Dominic Davis-Foster.
v5.2.1Compare Source
=====================================
Bugs fixed
pycon3lexer topycon.sphinx.ext.autosummarywith modules containing titles in themodule-level docstring.
v5.2.0Compare Source
===========================================
v5.1.1Compare Source
=====================================
Bugs fixed
dequebasedsphinx.ext.napoleaniterator implementation.
v5.1.0Compare Source
=====================================
Dependencies
Docutils 0.19_. Patch by Adam Turner... _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05
Deprecated
sphinx.util.stemmerin favour ofsnowballstemmer.Patch by Adam Turner.
sphinx.ext.napoleon.iterators.Features added
stylesheetsetting in
theme.confor by settinghtml_styleto an iterable of strings.optiondirectives through a new :confval:
option_emphasise_placeholdersconfigurationoption.
making whitespace issues easier to identify.
conf.pyfile. Patch byPradyun Gedam.
'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.
<aside>element whenusing Docutils 0.18 or later, to allow for easier styling. This matches the
behaviour introduced in Docutils 0.19. Patch by Adam Turner.
include_patternsas the opposite ofexclude_patterns.Patch by Adam Turner.
Bugs fixed
to missing
Node.findall()(refs: #10251)
+,-,~, and**). Patch by Adam Turner (refs: #10551).agogo.css_t.on next page
\colorcommands in topic or admonition boxes maycause color leaks in PDF due to upstream
framed.sty <https://ctan.org/pkg/framed>_bug
diffs using Pygments style
'manni') inherit thickness of code-block frame\labelis generated fordesc_signaturenodeeven if it has multiple node IDs
using
:any:and autodoc.v5.0.2Compare Source
=====================================
Features added
variable,
docutils_version_info. Patch by Adam Turner.Bugs fixed
if :confval:
autodoc_inherit_docstringis disabledPatch by Adam Turner.
v5.0.1Compare Source
=====================================
Bugs fixed
has no line number. Patch by Adam Turner.
topicdirective is rendered incorrectly withDocutils 0.18. Patch by Adam Turner.
kbdrole having a separator.Patch by Adam Turner.
v5.0.0Compare Source
=====================================
Dependencies
5.0.0 b1
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
sphinx.ext.autosummary.import_by_name()now raisesImportExceptionGroupinstead ofImportErrorwhen it failed to importtarget 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=Falsekeyword argument until v7.0.@definfoenclosecommand was not supported because the command was deprecated since texinfo 6.8
intersphinx_disabled_reftypeshas changed default valuefrom an empty list to
['std:doc']as avoid too surprising silentintersphinx 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.
body_min_widthsetting in basic theme to 360px'en'if any language is not set inconf.py5.0.0 final
languagedoes not acceptNoneas it value. The defaultvalue of
languagebecomes 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$uglobal objects, you need to update yourJavaScript or use the mitigation below.
To re-add jQuery and underscore.js, you will need to copy
jquery.jsandunderscore.jsfromthe Sphinx repository_ to yourstaticdirectory,and add the following to your
layout.html:.. _the Sphinx repository: https://github.com/sphinx-doc/sphinx/tree/v5.3.0/sphinx/themes/basic/static
.. 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 %}
Patch by Adam Turner.
setuptools integration. The
build_sphinxsub-command for setup.py ismarked as deprecated to follow the policy of setuptools team.
The
localeargument ofsphinx.util.i18n:babel_format_date()becomesrequired
The
languageargument ofsphinx.util.i18n:format_date()becomesrequired
sphinx.builders.html.html5_readysphinx.io.read_doc()sphinx.util.docutils.__version_info__sphinx.util.docutils.is_html5_writer_available()sphinx.writers.latex.LaTeXWriter.docclassesFeatures added
5.0.0 b1
autodoc_typehints_formatischanged to
'smart'. It will suppress the leading module names oftypehints (ex.
io.StringIO->StringIO).:inherited-members:option now takes multiple classes. Itallows to suppress inherited members of several classes on the module at once
by specifying the option to :rst:dir:
automoduledirectiveautodoc_typehints_description_targettoinclude undocumented return values but not undocumented parameters.
autodoc_typehints_formatnow also applies to attributes,data, properties, and type variable bounds.
non-imported
underscore.js) and modernised
doctools.jsandsearchtools.jstoEMCAScript 2018. Patch by Adam Turner.
?:).roledirective
Patch by Adam Turner.
Bugs fixed
5.0.0 b1
and .so files. Patch by Adam Turner and Takeshi KOMIYA.
functions are rendered as a string literal
autodoc_docstring_signatureunexpectedly generatesreturn value typehint for constructors if docstring has multiple signatures
autodoc_preserve_defaultsdoes not work formixture of keyword only arguments with/without defaults
function
via :confval:
autodoc_type_aliasesautodoc_preserve_defaultsdoesn't work on classmethods
languagecontains a country code (ex. zh_CN)
@definfoenclosecommand onbulding texinfo document
too much vertical whitespace
?inpdf output
'howto'title page rule use\linewidthforcompatibility with usage of a
twocolumnclass option:prepend:option of :rst:dir:literalincludedirective does notwork with
:dedent:option5.0.0 final
autodoc_typehints="description"*argsand**kwargsentries are duplicated whenautodoc_typehints="description"not provide correct information
:meta:fields are displayed if docstring contains twoor more meta-field
builder-finished event
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.