doc/tutorials/textreports/index.rst
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Tue, 28 Mar 2017 15:03:15 +0200
branch3.25
changeset 12115 8d0127498a28
parent 10491 c67bcee93248
permissions -rw-r--r--
Backed out changeset fe995d56c949 available_cubes should not strip cubicweb_prefix but return actual package name for cube as package, since its output is also used to e.g. get ccplugin or site_cubicweb module name. Original aim of this set was to fix output of the "cubicweb-ctl list" command. This will be done by an alternate implementation in a later cset.
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
10022
927a795bb380 [book] several fixes in the rst files
David Douard <david.douard@logilab.fr>
parents: 8852
diff changeset
    11
.. autofunction:: cubicweb.ext.rest.eid_reference_role
927a795bb380 [book] several fixes in the rst files
David Douard <david.douard@logilab.fr>
parents: 8852
diff changeset
    12
.. autofunction:: cubicweb.ext.rest.rql_role
927a795bb380 [book] several fixes in the rst files
David Douard <david.douard@logilab.fr>
parents: 8852
diff changeset
    13
.. autofunction:: cubicweb.ext.rest.bookmark_role