# HG changeset patch
# User Sylvain Thénault <sylvain.thenault@logilab.fr>
# Date 1284541997 -7200
# Node ID e7e9d73d0c07eafb4bd600751a81e7f81cf231ef
# Parent  1c4ac1626f3c3d3b4ae371a9a885ca4e46685f94
[doc] add note about x-ref in doc's README

diff -r 1c4ac1626f3c -r e7e9d73d0c07 doc/book/README
--- a/doc/book/README	Wed Sep 15 11:03:48 2010 +0200
+++ b/doc/book/README	Wed Sep 15 11:13:17 2010 +0200
@@ -46,9 +46,26 @@
 .. [foot note] the foot note content
 
 
+Cross references
+================
 
-XXX
-* lien vers cw.cwconfig.CW_CUBES_PATH par ex.
+To arbitrary section
+--------------------
+
+:ref:`identifier` ou :ref:`label <identifier>`
+
+Label required of referencing node which as no title, else the node's title will be used.
 
 
-automodule, autofunction, automethod, autofunction
+To API objects
+--------------
+See the autodoc sphinx extension documentation. Quick overview:
+
+* ref to a class: :class:`cubicweb.devtools.testlib.AutomaticWebTest`
+
+* if you can to see only the class name in the generated documentation, add a ~:
+  :class:`~cubicweb.devtools.testlib.AutomaticWebTest`
+
+* you can also use :mod: (module), :exc: (exception), :func: (function), :meth: (method)...
+
+* syntax explained above to specify label explicitly may also be used