Update dependency Sphinx to v4.3.1 #168
Merged
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.2.0
->==4.3.1
Release Notes
sphinx-doc/sphinx
v4.3.1
Compare Source
=====================================
Features added
:confval:
mathjax_options
Bugs fixed
decorated by functools.lru_cache
having invalid doc atribute
:confval:
autodoc_preserve_defaults
enableddocutils-0.17
of MathJax is back to "async" method again
v4.3.0
Compare Source
=====================================
Dependencies
Incompatible changes
searchindex.js
: the embedded data has changed format to allowobjects with the same name in different domains.
with more docutils nodes to allow better CSS styling.
It may break existing styling.
:py:meth:
domains.py.PyObject.get_signature_prefix
has changed toreturn a list of nodes instead of a plain string.
domains.js.JSObject.display_prefix
has been changed into a methodget_display_prefix
which now returns a list of nodesinstead of a plain string.
with more docutils nodes to allow better CSS styling.
It may break existing styling.
Deprecated
sphinx.ext.autodoc.AttributeDocumenter._datadescriptor
sphinx.writers.html.HTMLTranslator._fieldlist_row_index
sphinx.writers.html.HTMLTranslator._table_row_index
sphinx.writers.html5.HTML5Translator._fieldlist_row_index
sphinx.writers.html5.HTML5Translator._table_row_index
Features added
autodoc-process-bases
supports to inject reST snippet as abase class
retval
for :rst:dir:
c:function
and :rst:dir:c:macro
.retval
for :rst:dir:cpp:function
.gettext_allow_fuzzy_translations
to allow "fuzzy"messages for translation
add_stylesheet()
API. It will be kept untilthe Sphinx-6.0 release
intersphinx_disabled_reftypes
for disablinginterphinx resolution of cross-references that do not have an explicit
inventory specification. Specific types of cross-references can be disabled,
e.g.,
std:doc
or all cross-references in a specific domain,e.g.,
std:*
.warnings using :confval:
suppress_warnings
Bugs fixed
primary_domain
is not 'py'
:confval:
autodoc_typehints_description_target
is set to "documented" whenits info-field-list contains
:returns:
fieldgeneric class
autodoc_inherit_docstrings
does not effect tooverriden classmethods
autodoc_preserve_defaults
does not supporthexadecimal numeric
primary_domain
is not 'py'
return all of them as result instead of just one.
py:method
directive with
:property:
option:confval:
autodoc_typehints='description'
does not recognize
:class:`` optionbuild
e.g.,
proj:myFunc
, leave the inventory prefix in the unresolved text.Configuration
📅 Schedule: 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 WhiteSource Renovate. View repository job log here.