doc/book/README
author Christophe de Vienne <christophe@unlish.com>
Wed, 28 Jan 2015 14:03:00 +0100
changeset 10175 2659f8529a43
parent 6301 d9d6bdd814ba
permissions -rw-r--r--
[devtools] Make PostgresTestDataBaseHandler multi-use friendly Dont init the pgdb twice on the same datadir - If two test case with the same apphome use a Postgres configuration, the handler is initialised twice, so it has to check if the pgdb directory has already been initialized. - Work with the realpath of the pgdb In some cases, the self.config.apphome will resolve symbolic links, but not always. It can result in an attempt to start twice the pg server for the same directory, in the same test run... resulting in failure. Closes #4875827

====
Book
====

----
Part
----

Chapter
=======

.. _Level1AnchorForLaterReference:

Level 1 section
---------------

Level 2 section
~~~~~~~~~~~~~~~

Level 3 section
```````````````



*CubicWeb*


inline directives:
  :file:`directory/file`
  :envvar:`AN_ENV_VARIABLE`
  :command:`command --option arguments`

  :ref:, :mod:


.. sourcecode:: python

   class SomePythonCode:
     ...

.. XXX a comment, wont be rendered


a [foot note]_

.. [foot note] the foot note content


Boxes
=====

- warning box: 
    .. warning::

       Warning content
- note box:
    .. note::

       Note content



Cross references
================

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.


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