view doc/_ext/docstring.py @ 4193:730f542e4ad0

core: add new `init_script_path` option: `init_script_path` option can be used in `[DEFAULTS]` to run a script at the end of backend initialisation. A new `init_pre_script` method is used to wait for backend to reach this stage (designed to be used mostly by CLI frontend), then the usual `ready_get` method is finished once the script is finished.
author Goffi <goffi@goffi.org>
date Wed, 13 Dec 2023 22:00:22 +0100
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,
    }