doc/book/README
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Wed, 03 Feb 2010 18:44:50 +0100
changeset 4438 91e224154f11
parent 1714 a721966779be
child 6245 e7e9d73d0c07
permissions -rw-r--r--
more stuff in doc's README
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     1
====
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     2
Book
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     3
====
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     4
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     5
----
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     6
Part
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     7
----
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     8
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
     9
Chapter
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    10
=======
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    11
4438
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    12
.. _Level1AnchorForLaterReference:
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    13
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    14
Level 1 section
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    15
---------------
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    16
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    17
Level 2 section
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    18
~~~~~~~~~~~~~~~
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    19
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    20
Level 3 section
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    21
```````````````
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    22
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    23
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    24
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    25
*CubicWeb*
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    26
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    27
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    28
inline directives:
4438
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    29
  :file:`directory/file`
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    30
  :envvar:`AN_ENV_VARIABLE`
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    31
  :command:`command --option arguments`
1714
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    32
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    33
  :ref:, :mod:
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    34
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    35
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    36
.. sourcecode:: python
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    37
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    38
   class SomePythonCode:
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    39
     ...
a721966779be new book layout, do not compile yet
sylvain.thenault@logilab.fr
parents:
diff changeset
    40
4438
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    41
.. XXX a comment, wont be rendered
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    42
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    43
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    44
a [foot note]_
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    45
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    46
.. [foot note] the foot note content
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    47
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    48
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    49
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    50
XXX
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    51
* lien vers cw.cwconfig.CW_CUBES_PATH par ex.
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    52
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    53
91e224154f11 more stuff in doc's README
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1714
diff changeset
    54
automodule, autofunction, automethod, autofunction