Mercurial > libervia-backend
annotate doc/_ext/docstring.py @ 3769:a75874df92b8
tests (e2e/cli/cache_search): make the test more resilient:
the caching is triggered by `li.blog.get`, but it is done in parallel without blocking the
command, thus there is a possibility that the data is not yet in cache when the following
test is done.
A loop with delay is done, to be sure that cache is filled before doing the assertion.
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 13 May 2022 19:27:21 +0200 |
parents | 62e81b1058f8 |
children |
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 } |