doc: activate autodoc extension + extension to adapt Libervia docstring style to autodoc
This commit is contained in:
parent
0caebd3803
commit
198d103896
3 changed files with 26 additions and 3 deletions
0
doc/_ext/__init__.py
Normal file
0
doc/_ext/__init__.py
Normal file
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,
|
||||
}
|
||||
10
doc/conf.py
10
doc/conf.py
|
|
@ -12,13 +12,15 @@
|
|||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
import os
|
||||
import sys
|
||||
import os.path
|
||||
import re
|
||||
|
||||
|
||||
sys.path.insert(0, os.path.abspath("./_ext"))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'Libervia'
|
||||
|
|
@ -47,6 +49,8 @@ release = version_full
|
|||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
"sphinx.ext.autodoc",
|
||||
"docstring"
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
|
|
|||
Loading…
Reference in a new issue