jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/676710 )
Change subject: [soc] ignore magic methods from doc ......................................................................
[soc] ignore magic methods from doc
Change-Id: I975c3d78aa0f171ebc4838916d96f639cf85cc00 --- M docs/conf.py 1 file changed, 3 insertions(+), 1 deletion(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/docs/conf.py b/docs/conf.py index f237685..e4be68c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -450,9 +450,11 @@ def pywikibot_skip_members(app, what, name, obj, skip, options): """Skip certain members from documentation.""" inclusions = ('__init__', ) - exclusions = ('__dict__', '__weakref__',) + exclusions = () if name in inclusions: return False + if name.startswith('__') and name.endswith('__'): + return True if obj.__doc__ is not None \ and obj.__doc__.startswith(('DEPRECATED', 'Deprecated')): return True