Mercurial > libervia-backend

annotate doc/_ext/docstring.py @ 4323:a8bceb29b1ff

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core (memory/params): set default resource priority to 0: Priority was historically set to 50 to follow behaviour of other clients at the time, but it's nowadays a legacy feature, and a non zero value can cause trouble if message carbon is not used.
author Goffi <goffi@goffi.org>
date Wed, 20 Nov 2024 11:28:23 +0100
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 }