Skip to content
Snippets Groups Projects
Commit aa14abde authored by Paul McCarthy's avatar Paul McCarthy
Browse files

Using 'special-members' sphinx flag so that __init__ is documented separately.

parent 3c2c610d
No related branches found
No related tags found
No related merge requests found
...@@ -337,11 +337,13 @@ epub_exclude_files = ['search.html'] ...@@ -337,11 +337,13 @@ epub_exclude_files = ['search.html']
# If false, no index is generated. # If false, no index is generated.
#epub_use_index = True #epub_use_index = True
# ensure that class __init__ docstring is included. # Show the class level docstring
autoclass_content = 'both' # (__init__ is documented via the
# special-members flag)
autoclass_content = 'class'
# Document private members # Document private members and special members (e.g. __init__)
autodoc_default_flags = ['private-members'] autodoc_default_flags = ['private-members', 'special-members']
# Documentation for python modules is in the same order # Documentation for python modules is in the same order
# as the source code. # as the source code.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment