Skip to content

Commit 19c20fb

Browse files
committed
Tweaks to conf.py to help with formatting, etc.
1 parent f712eb1 commit 19c20fb

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

docs/conf.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,18 @@
1818
'sphinx.ext.napoleon'
1919
]
2020
autoapi_dirs = ['../dabench']
21-
autoapi_options = ['members', 'undoc-members', 'show-inheritance',
22-
'show-module-summary', 'special-members',
23-
'imported-members']
21+
# Important: Because we're not including "undoc-members",
22+
# you need to include a docstring on *everything* you want documented.
23+
# Including in __init__.py for submodules.
24+
autoapi_options = ['members', 'show-module-summary',
25+
'special-members', 'imported-members']
26+
2427
autodoc_typehints = 'description'
28+
autoapi_member_order = 'groupwise'
29+
autoapi_add_toctree_entry = True
30+
autoapi_own_page_level = 'module'
31+
napoleon_numpy_docstring = False
32+
napoleon_google_docstring = True
2533

2634
intersphinx_mapping = {
2735
'python': ('https://docs.python.org/3/', None),

0 commit comments

Comments
 (0)