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

Close #6830: autodoc: consider a member private if docstring has "private" metadata

Browse Source
This commit is contained in:
Takeshi KOMIYA
2020-01-01 14:40:13 +09:00
parent 0319faf8f1
commit b968bb91e9
11 changed files with 176 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGES
View File

@@ -16,6 +16,8 @@ Incompatible changes
:confval:`autosummary_generate_overwrite` to change the behavior
* #5923: autodoc: the members of ``object`` class are not documented by default
when ``:inherited-members:`` and ``:special-members:`` are given.
* #6830: py domain: ``meta`` fields in info-field-list becomes reserved. They
are not displayed on output document now
Deprecated
----------
@@ -29,8 +31,11 @@ Features added
old stub file
* #5923: autodoc: ``:inherited-members:`` option takes a name of anchestor class
not to document inherited members of the class and uppers
* #6830: autodoc: consider a member private if docstring contains
``:meta private:`` in info-field-list
* #6558: glossary: emit a warning for duplicated glossary entry
* #6558: std domain: emit a warning for duplicated generic objects
* #6830: py domain: Add new event: :event:`object-description-transform`
Bugs fixed
----------