sphinx-doc/sphinx
### [`v4.5.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-450-released-Mar-28-2022)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.4.0...v4.5.0)
\=====================================
## Incompatible changes
- [#10112](https://togithub.com/sphinx-doc/sphinx/issues/10112): extlinks: Disable hardcoded links detector by default
- [#9993](https://togithub.com/sphinx-doc/sphinx/issues/9993), [#10177](https://togithub.com/sphinx-doc/sphinx/issues/10177): std domain: Disallow to refer an inline target via
:rst:role:`ref` role
## Deprecated
- `sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()`
## Features added
- [#10260](https://togithub.com/sphinx-doc/sphinx/issues/10260): Enable `FORCE_COLOR` and `NO_COLOR` for terminal colouring
- [#10234](https://togithub.com/sphinx-doc/sphinx/issues/10234): autosummary: Add "autosummary" CSS class to summary tables
- [#10125](https://togithub.com/sphinx-doc/sphinx/issues/10125): extlinks: Improve suggestion message for a reference having title
- [#10112](https://togithub.com/sphinx-doc/sphinx/issues/10112): extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable
hardcoded links detector feature
- [#9494](https://togithub.com/sphinx-doc/sphinx/issues/9494), [#9456](https://togithub.com/sphinx-doc/sphinx/issues/9456): html search: Add a config variable
:confval:`html_show_search_summary` to enable/disable the search summaries
- [#9337](https://togithub.com/sphinx-doc/sphinx/issues/9337): HTML theme, add option `enable_search_shortcuts` that enables :kbd:'/' as
a Quick search shortcut and :kbd:`Esc` shortcut that
removes search highlighting.
- [#10107](https://togithub.com/sphinx-doc/sphinx/issues/10107): i18n: Allow to suppress translation warnings by adding `#noqa`
comment to the tail of each translation message
- [#10252](https://togithub.com/sphinx-doc/sphinx/issues/10252): C++, support attributes on classes, unions, and enums.
- [#10253](https://togithub.com/sphinx-doc/sphinx/issues/10253): :rst:dir:`pep` role now generates URLs based on peps.python.org
## Bugs fixed
- [#9876](https://togithub.com/sphinx-doc/sphinx/issues/9876): autodoc: Failed to document an imported class that is built from native
binary module
- [#10133](https://togithub.com/sphinx-doc/sphinx/issues/10133): autodoc: Crashed when mocked module is used for type annotation
- [#10146](https://togithub.com/sphinx-doc/sphinx/issues/10146): autodoc: :confval:`autodoc_default_options` does not support
`no-value` option
- [#9971](https://togithub.com/sphinx-doc/sphinx/issues/9971): autodoc: TypeError is raised when the target object is annotated by
unhashable object
- [#10205](https://togithub.com/sphinx-doc/sphinx/issues/10205): extlinks: Failed to compile regexp on checking hardcoded links
- [#10277](https://togithub.com/sphinx-doc/sphinx/issues/10277): html search: Could not search short words (ex. "use")
- [#9529](https://togithub.com/sphinx-doc/sphinx/issues/9529): LaTeX: named auto numbered footnote (ex. `[#named]`) that is referred
multiple times was rendered to a question mark
- [#9924](https://togithub.com/sphinx-doc/sphinx/issues/9924): LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical
spacing in Latexpdf
- [#10158](https://togithub.com/sphinx-doc/sphinx/issues/10158): LaTeX: excessive whitespace since v4.4.0 for undocumented
variables/structure members
- [#10175](https://togithub.com/sphinx-doc/sphinx/issues/10175): LaTeX: named footnote reference is linked to an incorrect footnote if
the name is also used in the different document
- [#10269](https://togithub.com/sphinx-doc/sphinx/issues/10269): manpage: Failed to resolve the title of :ref: cross references
- [#10179](https://togithub.com/sphinx-doc/sphinx/issues/10179): i18n: suppress "rST localization" warning
- [#10118](https://togithub.com/sphinx-doc/sphinx/issues/10118): imgconverter: Unnecessary availablity check is called for remote URIs
- [#10181](https://togithub.com/sphinx-doc/sphinx/issues/10181): napoleon: attributes are displayed like class attributes for google
style docstrings when :confval:`napoleon_use_ivar` is enabled
- [#10122](https://togithub.com/sphinx-doc/sphinx/issues/10122): sphinx-build: make.bat does not check the installation of sphinx-build
command before showing help
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.
[ ] If you want to rebase/retry this PR, click this checkbox.
Coverage remained the same at 88.669% when pulling 2f401f14e85e042d5677bda3c4e7d63e45f580a6 on renovate/sphinx-4.x into f678a0b074c2549a5b50a30606f59ce3b61be670 on develop.
This PR contains the following updates:
==4.4.0
->==4.5.0
Release Notes
sphinx-doc/sphinx
### [`v4.5.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-450-released-Mar-28-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.4.0...v4.5.0) \===================================== ## Incompatible changes - [#10112](https://togithub.com/sphinx-doc/sphinx/issues/10112): extlinks: Disable hardcoded links detector by default - [#9993](https://togithub.com/sphinx-doc/sphinx/issues/9993), [#10177](https://togithub.com/sphinx-doc/sphinx/issues/10177): std domain: Disallow to refer an inline target via :rst:role:`ref` role ## Deprecated - `sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()` ## Features added - [#10260](https://togithub.com/sphinx-doc/sphinx/issues/10260): Enable `FORCE_COLOR` and `NO_COLOR` for terminal colouring - [#10234](https://togithub.com/sphinx-doc/sphinx/issues/10234): autosummary: Add "autosummary" CSS class to summary tables - [#10125](https://togithub.com/sphinx-doc/sphinx/issues/10125): extlinks: Improve suggestion message for a reference having title - [#10112](https://togithub.com/sphinx-doc/sphinx/issues/10112): extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable hardcoded links detector feature - [#9494](https://togithub.com/sphinx-doc/sphinx/issues/9494), [#9456](https://togithub.com/sphinx-doc/sphinx/issues/9456): html search: Add a config variable :confval:`html_show_search_summary` to enable/disable the search summaries - [#9337](https://togithub.com/sphinx-doc/sphinx/issues/9337): HTML theme, add option `enable_search_shortcuts` that enables :kbd:'/' as a Quick search shortcut and :kbd:`Esc` shortcut that removes search highlighting. - [#10107](https://togithub.com/sphinx-doc/sphinx/issues/10107): i18n: Allow to suppress translation warnings by adding `#noqa` comment to the tail of each translation message - [#10252](https://togithub.com/sphinx-doc/sphinx/issues/10252): C++, support attributes on classes, unions, and enums. - [#10253](https://togithub.com/sphinx-doc/sphinx/issues/10253): :rst:dir:`pep` role now generates URLs based on peps.python.org ## Bugs fixed - [#9876](https://togithub.com/sphinx-doc/sphinx/issues/9876): autodoc: Failed to document an imported class that is built from native binary module - [#10133](https://togithub.com/sphinx-doc/sphinx/issues/10133): autodoc: Crashed when mocked module is used for type annotation - [#10146](https://togithub.com/sphinx-doc/sphinx/issues/10146): autodoc: :confval:`autodoc_default_options` does not support `no-value` option - [#9971](https://togithub.com/sphinx-doc/sphinx/issues/9971): autodoc: TypeError is raised when the target object is annotated by unhashable object - [#10205](https://togithub.com/sphinx-doc/sphinx/issues/10205): extlinks: Failed to compile regexp on checking hardcoded links - [#10277](https://togithub.com/sphinx-doc/sphinx/issues/10277): html search: Could not search short words (ex. "use") - [#9529](https://togithub.com/sphinx-doc/sphinx/issues/9529): LaTeX: named auto numbered footnote (ex. `[#named]`) that is referred multiple times was rendered to a question mark - [#9924](https://togithub.com/sphinx-doc/sphinx/issues/9924): LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical spacing in Latexpdf - [#10158](https://togithub.com/sphinx-doc/sphinx/issues/10158): LaTeX: excessive whitespace since v4.4.0 for undocumented variables/structure members - [#10175](https://togithub.com/sphinx-doc/sphinx/issues/10175): LaTeX: named footnote reference is linked to an incorrect footnote if the name is also used in the different document - [#10269](https://togithub.com/sphinx-doc/sphinx/issues/10269): manpage: Failed to resolve the title of :ref: cross references - [#10179](https://togithub.com/sphinx-doc/sphinx/issues/10179): i18n: suppress "rST localization" warning - [#10118](https://togithub.com/sphinx-doc/sphinx/issues/10118): imgconverter: Unnecessary availablity check is called for remote URIs - [#10181](https://togithub.com/sphinx-doc/sphinx/issues/10181): napoleon: attributes are displayed like class attributes for google style docstrings when :confval:`napoleon_use_ivar` is enabled - [#10122](https://togithub.com/sphinx-doc/sphinx/issues/10122): sphinx-build: make.bat does not check the installation of sphinx-build command before showing helpConfiguration
📅 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.