Update dependency sphinx to v3.5.4 #46
Open
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}
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:
==3.2.1->==3.5.4Release Notes
sphinx-doc/sphinx (sphinx)
v3.5.4=====================================
Dependencies
Bugs fixed
#9078: autodoc: Async staticmethods and classmethods are considered as non
async coroutine-functions with Python3.10
#8870, #9001, #9051: html theme: The style are not applied with Docutils 0.17
sidebardirectivev3.5.3=====================================
Features added
v3.5.2Compare Source
=====================================
Bugs fixed
v3.5.1Compare Source
=====================================
Bugs fixed
read-only class
:confval:
html_contextunparsable python module found
v3.5.0Compare Source
=====================================
Dependencies
multicol(it is anyhow a required part of the official latex2ebase distribution)
Incompatible changes
html_add_permalinksis replaced by:confval:
html_permalinksand :confval:html_permalinks_iconDeprecated
sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignoresphinx.builders.linkcheck.CheckExternalLinksBuilder.authsphinx.builders.linkcheck.CheckExternalLinksBuilder.brokensphinx.builders.linkcheck.CheckExternalLinksBuilder.goodsphinx.builders.linkcheck.CheckExternalLinksBuilder.redirectedsphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueuesphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignoresphinx.builders.linkcheck.CheckExternalLinksBuilder.workerssphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueuesphinx.builders.linkcheck.node_line_or_0()sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()sphinx.ext.autodoc.directive.DocumenterBridge.reportersphinx.ext.autodoc.importer.get_module_members()sphinx.ext.autosummary.generate._simple_info()sphinx.ext.autosummary.generate._simple_warn()sphinx.writers.html.HTMLTranslator.permalink_textsphinx.writers.html5.HTML5Translator.permalink_textFeatures added
value of the variable if docstring contains
:meta hide-value:ininfo-field-list
implementation if they're ellipsis
autodoc_default_optionsviadirective options
autodoc_preserve_defaultsasan experimental feature. It preserves the default argument values of
functions in source code and keep them not evaluated for readability.
priorityparameterfor :meth:
.Sphinx.add_js_file()and :meth:.Sphinx.add_css_file()calls
app.add_js_file()orapp.add_css_file()on:event:
html-page-contextevent:confval:
html_permalinks_iconSnowball (v2.1.0)
type
:confval:
napoleon_custom_sectionsreferences when :confval:
napoleon_preprocess_typesenabledproject_copyrightas an alias of :confval:copyrighthighlight_languagesupports multiple languagescode-blockand :rst:dir:literalincludesupports automaticdedent via no-argument
:dedent:optionmaxdepthoption to :rst:dir:cpp:aliasto insert nesteddeclarations.
norootoption to :rst:dir:c:aliasto render only nesteddeclarations.
norootoption to :rst:dir:cpp:aliasto render only nesteddeclarations.
Bugs fixed
class
:meta public:does not effect to variables__all__attribute is ignoredcontains invalid type comments
undocumented
object that raises an exception on
hasattr():recursive: option
search language that does not split on +)
footnote reference
availability of the same URL twice
copied
highlight_optionsis not workinghtml_last_updated_fmtdoes not support UTC offset (%z)html_last_updated_fmtgenerates wrong time zone for %Zdownloadrole creates duplicated copies when relative path isspecified
and for manually numbered footnotes only first one with same number is
an hyperlink
in definition of
\FNH@prefntext"in Sphinx (how to generate one-column index)
hlistnot implemented in LaTeXindexrole and the glossary generate duplicateentries in the LaTeX index (if both used for same term)
:confval:
numfigis notTrue(or pdflatex and :confval:
latex_use_xindyset toTrue) with memoir classinside function type signatures
\titleformatlast argument in sphinx.sty should bebracketed, not braced (and is anyhow not needed)
boolean :ref:
verbatimforcewraps <latexsphinxsetupforcewraps>for use viathe :ref:
'sphinxsetup' <latexsphinxsetup>key oflatex_elements)builds
builds
unnoticed so far
c:aliasskip symbols without explicit declarationsinstead of crashing.
c:aliasgive a warning when the root symbol is not declared.exprrole should start symbol lookup in the current scope.v3.4.3Compare Source
=====================================
Bugs fixed
object that raises an exception on
hasattr()v3.4.2Compare Source
=====================================
Bugs fixed
autodoc-process-docstringevent is emitted to thenon-datadescriptors unexpectedly
autoclass directive
v3.4.1Compare Source
=====================================
Bugs fixed
annotations
autodoc-process-docstringevent is emitted to thealias classes unexpectedly
__eq__methodcomparable
v3.4.0Compare Source
=====================================
Incompatible changes
classes, not a signature of decorator
Deprecated
follow_wrappedargument ofsphinx.util.inspect.signature()no_docstringargument ofsphinx.ext.autodoc.Documenter.add_content()sphinx.ext.autodoc.Documenter.get_object_members()sphinx.ext.autodoc.DataDeclarationDocumentersphinx.ext.autodoc.GenericAliasDocumentersphinx.ext.autodoc.InstanceAttributeDocumentersphinx.ext.autodoc.SlotsAttributeDocumentersphinx.ext.autodoc.TypeVarDocumentersphinx.ext.autodoc.importer._getannotations()sphinx.ext.autodoc.importer._getmro()sphinx.pycode.ModuleAnalyzer.parse()sphinx.util.osutil.movefile()sphinx.util.requests.is_ssl_error()Features added
__all__attribute of the module should be documented or not via:event:
autodoc-skip-membereventa generic class and show-inheritance option is given (in Python 3.7 or above)
Documenter.configas a shortcut to access the config objectOptional[t]to annotation of function and method if a defaultvalue equal to
Noneis set.:no-value:option to :rst:dir:autoattributeand:rst:dir:
autodatadirective to suppress the default value of the variablenapoleon_attr_annotationsto merge type hintson source code automatically if any type is specified in docstring
warn-missing-referenceto custom warningmessages when failed to resolve a cross-reference
:ref:reference:confval:
linkcheck_rate_limit_timeoutfor details.Bugs fixed
is decorated
autodoc_type_aliasesdoes not effect to variablesand attributes
type annotated variables
based uninitialized variables
attributes
class attributes correctly
attribute in alias class
set to "description"
instance attributes
information of TypeVars
__bool__method could be calledsuper class is not displayed
class
multibyte characters
language_data.jsin non-search pages-D gettext_compact=0is no longer workingaccommodate infinite redirect loops on HEAD
make cleanwith empty BUILDDIR is dangerous:type:and:rtype:gives false ambiguous classlookup warnings
v3.3.1Compare Source
=====================================
Bugs fixed
without init.py
v3.3.0Compare Source
=====================================
Deprecated
sphinx.builders.latex.LaTeXBuilder.usepackagessphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperrefsphinx.ext.autodoc.SingledispatchFunctionDocumentersphinx.ext.autodoc.SingledispatchMethodDocumenterFeatures added
html_static_files
maxdepthoption to :rst:dir:c:aliasto insertnested declarations.
app.add_latex_package()untiljust before writing .tex file
man_make_section_directoryto make a sectiondirectory on build man page
builder using :confval:
suppress_warnings.sphinx-quickstart --no-sepoptionnapoleon_preprocess_typesto every fielddetected.
Bugs fixed
AttributeErroris raised whenFalsevalue is passed to:confval:
autodoc_default_optionsby string not ending with blank lines
typing.Generic
output on building
to decimal
singlehtml and so on)
linkcheck_anchorsisTruetel:schema hyperlinks are detected as errorsschema found
e.g., preventing intersphinx from resolving them.
non-function declaration of the same name already exists.
Link to the function instead of a non-existing anchor.
Testing
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 was generated by Mend Renovate. View the repository job log.