Release 5.0.0 beta1 (released May 09, 2022) ¶
Dependencies ¶
-
#10164: Support Docutils 0.18 . Patch by Adam Turner.
Incompatible changes ¶
-
#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:
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
Features added ¶
-
#9075: autodoc: The default value of
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 toautomodule
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:
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. -
#10302: C++, add support for conditional expressions (
?:
). -
#5157, #10251: Inline code is able to be highlighted via
role
directive -
#10337: Make sphinx-build faster by caching Publisher object during build