doc/book/en/tutorials/textreports/index.rst
author Julien Cristau <julien.cristau@logilab.fr>
Wed, 17 Sep 2014 13:43:31 +0200
branchstable
changeset 9947 6343d91f5200
parent 8852 59a29405688c
child 10022 927a795bb380
permissions -rw-r--r--
merge 3.17.17 into 3.18 branch
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8852
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     1
.. -*- coding: utf-8 -*-
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     2
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     3
Writing text reports with RestructuredText
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     4
==========================================
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     5
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     6
|cubicweb| offers several text formats for the RichString type used in schemas,
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     7
including restructuredtext.
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     8
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     9
Three additional restructuredtext roles are defined by |cubicweb|:
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    10
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    11
.. autodocfunction:: cubicweb.ext.rest.eid_reference_role
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    12
.. autodocfunction:: cubicweb.ext.rest.rql_role
59a29405688c [ext/rest] add directive bookmark to rest (closes #2545595)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    13
.. autodocfunction:: cubicweb.ext.rest.bookmark_role