Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Sean Fitzgibbon
fslpy
Commits
72ec52ba
Commit
72ec52ba
authored
Jun 23, 2020
by
Paul McCarthy
🚵
Browse files
MNT: Update sphinx config
parent
114bf373
Changes
1
Hide whitespace changes
Inline
Side-by-side
doc/conf.py
View file @
72ec52ba
...
...
@@ -361,26 +361,12 @@ epub_exclude_files = ['search.html']
# special-members flag)
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
# as the source code.
autodoc_member_order
=
'bysource'
def
autodoc_skip_member
(
app
,
what
,
name
,
obj
,
skip
,
options
):
# 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
)
autodoc_default_options
=
{
'special-members'
:
True
,
'private-members'
:
True
,
'undoc-members'
:
True
,
'member-order'
:
'bysource'
,
}
graphviz_output_format
=
'svg'
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment