doc/changes/5.0.rst
docutils_version_info. Patch by Adam Turner.autodoc_inherit_docstring is disabledtopic directive is rendered incorrectly with
Docutils 0.18. Patch by Adam Turner.kbd role having a separator.
Patch by Adam Turner.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
5.0.0 b1
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.@definfoenclose
command was not supported because the command was deprecated since texinfo 6.8intersphinx_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.body_min_width setting in basic theme to 360px'en' if any language is not set in
conf.py5.0.0 final
language does not accept None as it value. The default
value of language becomes to 'en' now.
Patch by Adam Turner and Takeshi KOMIYA.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 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/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_sphinx sub-command for setup.py is
marked as deprecated to follow the policy of setuptools team.
The locale argument of sphinx.util.i18n:babel_format_date() becomes
required
The language argument of sphinx.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
5.0.0 b1
autodoc_typehints_format is
changed to 'smart'. It will suppress the leading module names of
typehints (ex. io.StringIO -> StringIO).: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 directiveautodoc_typehints_description_target to
include undocumented return values but not undocumented parameters.autodoc_typehints_format now also applies to attributes,
data, properties, and type variable bounds.doctools.js and searchtools.js to
EMCAScript 2018. Patch by Adam Turner.?:).role
directive5.0.0 b1
autodoc_docstring_signature unexpectedly generates
return value typehint for constructors if docstring has multiple signaturesautodoc_preserve_defaults does not work for
mixture of keyword only arguments with/without defaultsautodoc_type_aliasesautodoc_preserve_defaults doesn't work on class
methodslanguage
contains a country code (ex. zh_CN)@definfoenclose command on
building texinfo document? in
pdf output'howto' title page rule use \linewidth for
compatibility with usage of a twocolumn class option:prepend: option of :rst:dir:literalinclude directive does not
work with :dedent: option5.0.0 final
autodoc_typehints="description"*args and **kwargs entries are duplicated when
autodoc_typehints="description":meta: fields are displayed if docstring contains two
or more meta-field