doc/tutorials/textreports/index.rst
author Philippe Pepiot <philippe.pepiot@logilab.fr>
Tue, 17 Mar 2020 13:31:50 +0100
branch3.27
changeset 12916 7d67f69ebe88
parent 10491 c67bcee93248
permissions -rw-r--r--
[pkg] add python3 only pypi specifiers This is only for pypi statistics purposes. Also add 'Programming Language :: Python', looks obvious but seems to be sane to have this as well.
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