IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update CHANGES for PR #8539

Browse Source
This commit is contained in:
Takeshi KOMIYA 2021-04-03 23:33:35 +09:00
parent ddb6e9c61c
commit a476559abf
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGES
View File

@ -11,6 +11,8 @@ Dependencies
Incompatible changes Incompatible changes
-------------------- --------------------
* #8539: autodoc: info-field-list is generated into the class description when
``autodoc_typehints='description'`` and ``autoclass_content='class'`` set
* domain: The ``Index`` class becomes subclasses of ``abc.ABC`` to indicate * domain: The ``Index`` class becomes subclasses of ``abc.ABC`` to indicate
methods that must be overrided in the concrete classes methods that must be overrided in the concrete classes
* #4826: py domain: The structure of python objects is changed. A boolean value * #4826: py domain: The structure of python objects is changed. A boolean value
@ -68,6 +70,8 @@ Features added
* #7383: autodoc: Support typehints for properties * #7383: autodoc: Support typehints for properties
* #5603: autodoc: Allow to refer to a python class using its canonical name * #5603: autodoc: Allow to refer to a python class using its canonical name
when the class has two different names; a canonical name and an alias name when the class has two different names; a canonical name and an alias name
* #8539: autodoc: Add :confval:`autodoc_typehints_description_target` to control
the behavior of ``autodoc_typehints=description``
* #7549: autosummary: Enable :confval:`autosummary_generate` by default * #7549: autosummary: Enable :confval:`autosummary_generate` by default
* #4826: py domain: Add ``:canonical:`` option to python directives to describe * #4826: py domain: Add ``:canonical:`` option to python directives to describe
the location where the object is defined the location where the object is defined