improve auto doc
This commit is contained in:
parent
2719f71b06
commit
72b759504b
38 changed files with 115 additions and 37 deletions
10
docs/conf.py
10
docs/conf.py
|
|
@ -41,3 +41,13 @@ autodoc_mock_imports = [
|
|||
html_theme = 'sphinx_rtd_theme'
|
||||
html_theme_path = ["_themes", ]
|
||||
html_static_path = ['_static']
|
||||
|
||||
def polish_module_docstring(app, what, name, obj, options, lines):
|
||||
if what == "module" and 'members' in options:
|
||||
try:
|
||||
del lines[lines.index('---'):]
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
def setup(app):
|
||||
app.connect("autodoc-process-docstring", polish_module_docstring)
|
||||
Loading…
Add table
Add a link
Reference in a new issue