Mercurial > libervia-backend

annotate doc/_ext/docstring.py @ 3942:a92eef737703

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
plugin XEP-0373: download public keys if they are not found in local storage: public keys were only obtained from PEP notifications, however this wasn't working if the entity was not in our roster. Now if no public key is retrieved from local storage, the public key node is requested, and an error is raised if nothing is found. This allows the use of OX with entities which are not in roster. rel 380
author Goffi <goffi@goffi.org>
date Sat, 15 Oct 2022 20:38:33 +0200
parents 62e81b1058f8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3605
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/env python3
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
2
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
3 """Adapt Libervia docstring style to autodoc"""
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
4
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
5
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
6 def process_docstring(app, what, name, obj, options, lines):
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
7 lines[:] = [
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
8 l.replace("@param", ":param").replace("@raise", ":raises")
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
9 for l in lines
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
10 ]
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
11
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
12
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
13 def setup(app):
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
14 app.connect("autodoc-process-docstring", process_docstring)
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
15 return {
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
16 'version': '0.1',
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
17 'parallel_read_safe': True,
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
18 'parallel_write_safe': True,
62e81b1058f8 doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff changeset
19 }