annotate doc/_ext/docstring.py @ 3732:0fac164ff2d8

tools (xml_tools): fix `widget_args` modification in `_dataFormField2XMLUIData`: in `textbox` widget, the first arg was modified with all values, lettings other ones unchanger, resulting in invalid number of arguments. This has been fixed by replacing all args with the new value.
author Goffi <goffi@goffi.org>
date Mon, 31 Jan 2022 18:35:52 +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 }