doc: activate autodoc extension + extension to adapt Libervia docstring style to autodoc

This commit is contained in:
Goffi 2021-07-29 22:51:01 +02:00
commit 198d103896

19
doc/_ext/docstring.py Normal file
View 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,
}