view doc/_ext/docstring.py @ 4145:970b6209526a

frontends (tools/webrtc): Better message on Python override missing: raise an exception instead of simple `print` to stop loading the module, and show a more detailed message with the package to install.
author Goffi <goffi@goffi.org>
date Thu, 02 Nov 2023 12:11:21 +0100 (17 months ago)
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,
    }