view doc/_ext/docstring.py @ 4254:2b2a5348bd61

app (peertube): environment variable must be strings (bis)
author Goffi <goffi@goffi.org>
date Fri, 31 May 2024 11:24:12 +0200
parents 62e81b1058f8
children
line wrap: on
line source

#!/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,
    }