docs/index.rst
changeset 11537 caf268942436
child 11541 732b00868f00
equal deleted inserted replaced
11536:6618408c0629 11537:caf268942436
       
     1 ================
       
     2 Pyramid Cubicweb
       
     3 ================
       
     4 
       
     5 Pyramid Cubicweb is an attempt to rebase the CubicWeb_ framework on pyramid.
       
     6 
       
     7 It can be used in two different ways:
       
     8 
       
     9 -   Within CubicWeb, through the 'pyramid' cube and the
       
    10     :ref:`pyramid command <cubicweb-ctl_pyramid>`.
       
    11     In this mode, the Pyramid CubicWeb replaces some parts of
       
    12     CubicWeb and make the pyramid api available to the cubes.
       
    13 
       
    14 -   Within a pyramid application, it provides easy access to a CubicWeb
       
    15     instance and registry.
       
    16 
       
    17 Narrative Documentation
       
    18 =======================
       
    19 
       
    20 .. toctree::
       
    21     :maxdepth: 2
       
    22     
       
    23     narr/quickstart
       
    24     narr/ctl
       
    25     narr/settings
       
    26     narr/profiling
       
    27 
       
    28 Api Documentation
       
    29 =================
       
    30 
       
    31 .. toctree::
       
    32     :maxdepth: 2
       
    33     :glob:
       
    34 
       
    35     api
       
    36 
       
    37 Indices and tables
       
    38 ==================
       
    39 
       
    40 * :ref:`genindex`
       
    41 * :ref:`modindex`
       
    42 * :ref:`search`
       
    43 
       
    44 
       
    45 .. _CubicWeb: http://www.cubicweb.org/