Mercurial > libervia-backend
view doc/_ext/docstring.py @ 3771:e597dbfbc4c6
doc (cli/pubsub): document new `--public` flags:
`--public` option is documented for `subscribe`, `subscriptions` and `node subscriptions
get`, with examples. A warning has been added to show explicitely the privacy implication
of using `--public` with `subscribe`.
rel 365
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 13 May 2022 19:32:06 +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, }