8da48c4a2b
Release 4.5.0 (released Mar 28, 2022)
=====================================
Incompatible changes
--------------------
* extlinks: Disable hardcoded links detector by default
* std domain: Disallow to refer an inline target via
:rst:role:`ref` role
Deprecated
----------
* ``sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()``
Features added
--------------
* Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring
* autosummary: Add "autosummary" CSS class to summary tables
* extlinks: Improve suggestion message for a reference having title
* extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable
hardcoded links detector feature
* html search: Add a config variable
:confval:`html_show_search_summary` to enable/disable the search summaries
* HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:'/' as
a Quick search shortcut and :kbd:`Esc` shortcut that
removes search highlighting.
* i18n: Allow to suppress translation warnings by adding ``#noqa``
comment to the tail of each translation message
* C++, support attributes on classes, unions, and enums.
* :rst:dir:`pep` role now generates URLs based on peps.python.org
Bugs fixed
----------
* autodoc: Failed to document an imported class that is built from native
binary module
* autodoc: Crashed when mocked module is used for type annotation
* autodoc: :confval:`autodoc_default_options` does not support
``no-value`` option
* autodoc: TypeError is raised when the target object is annotated by
unhashable object
* extlinks: Failed to compile regexp on checking hardcoded links
* html search: Could not search short words (ex. "use")
* LaTeX: named auto numbered footnote (ex. ``[#named]``) that is referred
multiple times was rendered to a question mark
* LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical
spacing in Latexpdf
* LaTeX: excessive whitespace since v4.4.0 for undocumented
variables/structure members
* LaTeX: named footnote reference is linked to an incorrect footnote if
the name is also used in the different document
* manpage: Failed to resolve the title of :ref: cross references
* i18n: suppress "rST localization" warning
* imgconverter: Unnecessary availablity check is called for remote URIs
* napoleon: attributes are displayed like class attributes for google
style docstrings when :confval:`napoleon_use_ivar` is enabled
* sphinx-build: make.bat does not check the installation of sphinx-build
command before showing help
|
||
|---|---|---|
| .. | ||
| ALTERNATIVES | ||
| DESCR | ||
| distinfo | ||
| Makefile | ||
| PLIST | ||