view doc/_ext/docstring.py @ 3767:fd3fe346a14a

docker (backend-dev): move dbus unix socket: there seem to be a regression with Docker: the volume is not propagated anymore with pre-existing files when a unix socket is inside. This is the case in `backend-dev` with the D-Bus unix socket put in `/home/libervia/.local/share/libervia/dbus_socket`, when the volume is mounted at `/home/libervia/.local/share/libervia/`, resulting in hard to debug failures. To work around that, the socket is not put in the volume mount point anymore, and has been moved to `/home/libervia/.local/share/`
author Goffi <goffi@goffi.org>
date Fri, 13 May 2022 19:21:17 +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,
    }