From aa14abde16088b80c9ecdeb3b0501f50d36157bf Mon Sep 17 00:00:00 2001 From: Paul McCarthy <pauld.mccarthy@gmail.com> Date: Fri, 11 Sep 2015 10:55:05 +0100 Subject: [PATCH] Using 'special-members' sphinx flag so that __init__ is documented separately. --- doc/conf.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 4d9c3e553..4f8bc0ab8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -337,11 +337,13 @@ epub_exclude_files = ['search.html'] # If false, no index is generated. #epub_use_index = True -# ensure that class __init__ docstring is included. -autoclass_content = 'both' +# Show the class level docstring +# (__init__ is documented via the +# special-members flag) +autoclass_content = 'class' -# Document private members -autodoc_default_flags = ['private-members'] +# Document private members and special members (e.g. __init__) +autodoc_default_flags = ['private-members', 'special-members'] # Documentation for python modules is in the same order # as the source code. -- GitLab