doc: activate autodoc extension + extension to adapt Libervia docstring style to autodoc
This commit is contained in:
parent
0caebd3803
commit
198d103896
1 changed files with 26 additions and 3 deletions
19
doc/_ext/docstring.py
Normal file
19
doc/_ext/docstring.py
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
"""Adapt Libervia docstring style to autodoc"""
|
||||
|
||||
|
||||
def process_docstring(app, what, name, obj, options, lines):
|
||||
lines[:] = [
|
||||
l.replace("@param", ":param").replace("@raise", ":raises")
|
||||
for l in lines
|
||||
]
|
||||
|
||||
|
||||
def setup(app):
|
||||
app.connect("autodoc-process-docstring", process_docstring)
|
||||
return {
|
||||
'version': '0.1',
|
||||
'parallel_read_safe': True,
|
||||
'parallel_write_safe': True,
|
||||
}
|
||||
Loading…
Reference in a new issue