[book] fix docstrings to please sphinx
authorDavid Douard <david.douard@logilab.fr>
Thu, 28 Aug 2014 18:54:21 +0200
changeset 10023 c3ab46842b2d
parent 10022 927a795bb380
child 10024 2a08247b57fb
[book] fix docstrings to please sphinx example rst roles in docstring must be protected (in a literal).
ext/rest.py
--- a/ext/rest.py	Thu Aug 28 18:52:41 2014 +0200
+++ b/ext/rest.py	Thu Aug 28 18:54:21 2014 +0200
@@ -99,9 +99,9 @@
                             **options)], []
 
 def rql_role(role, rawtext, text, lineno, inliner, options={}, content=[]):
-    """:rql:`<rql-expr>` or :rql:`<rql-expr>:<vid>`
+    """``:rql:`<rql-expr>``` or ``:rql:`<rql-expr>:<vid>```
 
-    Example: :rql:`Any X,Y WHERE X is CWUser, X login Y:table`
+    Example: ``:rql:`Any X,Y WHERE X is CWUser, X login Y:table```
 
     Replace the directive with the output of applying the view to the resultset
     returned by the query.
@@ -132,9 +132,9 @@
     return [nodes.raw('', content, format='html')], []
 
 def bookmark_role(role, rawtext, text, lineno, inliner, options={}, content=[]):
-    """:bookmark:`<bookmark-eid>` or :bookmark:`<eid>:<vid>`
+    """``:bookmark:`<bookmark-eid>``` or ``:bookmark:`<eid>:<vid>```
 
-    Example: :bookmark:`1234:table`
+    Example: ``:bookmark:`1234:table```
 
     Replace the directive with the output of applying the view to the resultset
     returned by the query stored in the bookmark. By default, the view is the one