Skip to content

Commit 00d0537

Browse files
iampopovichdiemol
andauthored
[fix] sphinx config update to keep invoked methods and shorter aliases in documentation (#11802)
update sphinx config Closes #11004 Co-authored-by: Diego Molina <[email protected]>
1 parent 37d3f67 commit 00d0537

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

py/docs/source/conf.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,5 +271,13 @@
271271
# functions without docstrings.
272272
autodoc_default_flags = ['members', 'undoc-members']
273273

274+
# configuration for keeping the methods that can be invoked on said classes
275+
autodoc_default_options = {
276+
'members': True,
277+
'member-order': 'bysource',
278+
'undoc-members': True,
279+
'inherited-members': True,
280+
}
281+
274282
# Include __init__ comments
275283
autoclass_content = "both"

0 commit comments

Comments
 (0)