# HG changeset patch # User David Douard # Date 1409244861 -7200 # Node ID c3ab46842b2d50ed4632ae3dba2f57c98f94743a # Parent 927a795bb380db5a4a0d0166a00a5f8c3c648cd0 [book] fix docstrings to please sphinx example rst roles in docstring must be protected (in a literal). diff -r 927a795bb380 -r c3ab46842b2d 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:`` or :rql:`:` + """``:rql:```` or ``:rql:`:``` - 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:`` or :bookmark:`:` + """``:bookmark:```` or ``:bookmark:`:``` - 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