Commit 72ec52ba authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

MNT: Update sphinx config

parent 114bf373
...@@ -361,26 +361,12 @@ epub_exclude_files = ['search.html'] ...@@ -361,26 +361,12 @@ epub_exclude_files = ['search.html']
# special-members flag) # special-members flag)
autoclass_content = 'class' autoclass_content = 'class'
# 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 autodoc_default_options = {
# as the source code. 'special-members' : True,
autodoc_member_order = 'bysource' 'private-members' : True,
'undoc-members' : True,
def autodoc_skip_member(app, what, name, obj, skip, options): 'member-order' : 'bysource',
}
# Do not document the _sync_* properties
# that are added by the props package to
# all SyncableHasProperties classes.
if what == 'class':
attName = name.split('.')[-1]
return skip or attName.startswith('_sync_')
return skip or False
def setup(app):
app.connect('autodoc-skip-member', autodoc_skip_member)
graphviz_output_format = 'svg' graphviz_output_format = 'svg'
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment