doc/tutorials/textreports/index.rst
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Fri, 18 Nov 2016 17:50:56 +0100
changeset 11891 67185e65f020
parent 10491 c67bcee93248
permissions -rw-r--r--
[entity/optimization] Cache rset when entity.related is called with entities=False If fail to see why we couldn't cache in this case, while this is important for optimization reason: when doing a single HTTP request, some queries are done two or three times because of predicates / uicfg or alike. Also always store tuple and not list in the cache, because: * else we get some regression * and inconsistent result type (tuple or list) * and it simply feels better to cache an unmutable object.

.. -*- coding: utf-8 -*-

Writing text reports with RestructuredText
==========================================

|cubicweb| offers several text formats for the RichString type used in schemas,
including restructuredtext.

Three additional restructuredtext roles are defined by |cubicweb|:

.. autofunction:: cubicweb.ext.rest.eid_reference_role
.. autofunction:: cubicweb.ext.rest.rql_role
.. autofunction:: cubicweb.ext.rest.bookmark_role