mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fix #4091: Private members not documented without :undoc-members:
This commit is contained in:
parent
4bc4b35352
commit
cb860f0d30
1
CHANGES
1
CHANGES
@ -39,6 +39,7 @@ Bugs fixed
|
|||||||
``\chapter`` commands
|
``\chapter`` commands
|
||||||
* #4214: Two todolist directives break sphinx-1.6.5
|
* #4214: Two todolist directives break sphinx-1.6.5
|
||||||
* Fix links to external option docs with intersphinx (refs: #3769)
|
* Fix links to external option docs with intersphinx (refs: #3769)
|
||||||
|
* #4091: Private members not documented without :undoc-members:
|
||||||
|
|
||||||
Testing
|
Testing
|
||||||
--------
|
--------
|
||||||
|
@ -965,8 +965,7 @@ class Documenter(object):
|
|||||||
elif (namespace, membername) in attr_docs:
|
elif (namespace, membername) in attr_docs:
|
||||||
if want_all and membername.startswith('_'):
|
if want_all and membername.startswith('_'):
|
||||||
# ignore members whose name starts with _ by default
|
# ignore members whose name starts with _ by default
|
||||||
keep = self.options.private_members and \
|
keep = self.options.private_members
|
||||||
(has_doc or self.options.undoc_members)
|
|
||||||
else:
|
else:
|
||||||
# keep documented attributes
|
# keep documented attributes
|
||||||
keep = True
|
keep = True
|
||||||
|
Loading…
Reference in New Issue
Block a user