- #10523: HTML Theme: Expose the Docutils's version info tuple as a template
variable,
docutils_version_info. Patch by Adam Turner.
- #10538: autodoc: Inherited class attribute having docstring is documented even if :confval:`autodoc_inherit_docstring` is disabled
- #10509: autosummary: autosummary fails with a shared library
- #10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.
- #10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+. Patch by Adam Turner.
- #10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.
- #10498: gettext: TypeError is raised when sorting warning messages if a node has no line number. Patch by Adam Turner.
- #10493: HTML Theme: :dudir:`topic` directive is rendered incorrectly with Docutils 0.18. Patch by Adam Turner.
- #10495: IndexError is raised for a :rst:role:`kbd` role having a separator. Patch by Adam Turner.
5.0.0 b1
- #10164: Support Docutils 0.18. Patch by Adam Turner.
5.0.0 b1
- #10031: autosummary:
sphinx.ext.autosummary.import_by_name()now raisesImportExceptionGroupinstead ofImportErrorwhen 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=Falsekeyword argument until v7.0. - #9962: texinfo: Customizing styles of emphasized text via
@definfoenclosecommand was not supported because the command was deprecated since texinfo 6.8 - #2068: :confval:`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_widthsetting 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
5.0.0 final
- #10474: :confval:`language` does not accept
Noneas it value. The default value oflanguagebecomes 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$uglobal 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.jsandunderscore.jsfrom the Sphinx repository to yourstaticdirectory, and add the following to yourlayout.html:{%- 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 is marked as deprecated to follow the policy of setuptools team.The
localeargument ofsphinx.util.i18n:babel_format_date()becomes requiredThe
languageargument ofsphinx.util.i18n:format_date()becomes requiredsphinx.builders.html.html5_readysphinx.io.read_doc()sphinx.util.docutils.__version_info__sphinx.util.docutils.is_html5_writer_available()sphinx.writers.latex.LaTeXWriter.docclasses
5.0.0 b1
- #9075: autodoc: The default value of :confval:`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 to :rst:dir:`automodule` directive - #9792: autodoc: Add new option for
autodoc_typehints_description_targetto include undocumented return values but not undocumented parameters. - #10285: autodoc: singledispatch functions having typehints are not documented
- autodoc: :confval:`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.jsandsearchtools.jsto EMCAScript 2018. Patch by Adam Turner. - #10302: C++, add support for conditional expressions (
?:). - #5157, #10251: Inline code is able to be highlighted via :dudir:`role` directive
- #10337: Make sphinx-build faster by caching Publisher object during build. Patch by Adam Turner.
5.0.0 b1
- #10200: apidoc: Duplicated submodules are shown for modules having both .pyx and .so files. Patch by Adam Turner and Takeshi KOMIYA.
- #10279: autodoc: Default values for keyword only arguments in overloaded functions are rendered as a string literal
- #10280: autodoc: :confval:`autodoc_docstring_signature` unexpectedly generates return value typehint for constructors if docstring has multiple signatures
- #10266: autodoc: :confval:`autodoc_preserve_defaults` does not work for mixture of keyword only arguments with/without defaults
- #10310: autodoc: class methods are not documented when decorated with mocked function
- #10305: autodoc: Failed to extract optional forward-ref'ed typehints correctly via :confval:`autodoc_type_aliases`
- #10421: autodoc: :confval:`autodoc_preserve_defaults` doesn't work on class methods
- #10214: html: invalid language tag was generated if :confval:`language` contains a country code (ex. zh_CN)
- #9974: html: Updated jQuery version from 3.5.1 to 3.6.0
- #10236: html search: objects are duplicated in search result
- #9962: texinfo: Deprecation message for
@definfoenclosecommand on building texinfo document - #10000: LaTeX: glossary terms with common definition are rendered with too much vertical whitespace
- #10188: LaTeX: alternating multiply referred footnotes produce a
?in pdf output - #10363: LaTeX: make
'howto'title page rule use\linewidthfor compatibility with usage of atwocolumnclass option - #10318:
:prepend:option of :rst:dir:`literalinclude` directive does not work with:dedent:option
5.0.0 final
- #9575: autodoc: The annotation of return value should not be shown when
autodoc_typehints="description" - #9648: autodoc:
*argsand**kwargsentries are duplicated whenautodoc_typehints="description" - #8180: autodoc: Docstring metadata ignored for attributes
- #10443: epub: EPUB builder can't detect the mimetype of .webp file
- #10104: gettext: Duplicated locations are shown if 3rd party extension does not provide correct information
- #10456: py domain:
:meta:fields are displayed if docstring contains two or more meta-field - #9096: sphinx-build: the value of progress bar for parallel build is wrong
- #10110: sphinx-build: exit code is not changed when error is raised on builder-finished event