doc/book/pyramid/index.rst
author Laurent Peuch <cortex@worlddomination.be>
Wed, 18 Dec 2019 05:39:42 +0100
changeset 12819 053329493511
parent 12096 b8bfcab1a91c
permissions -rw-r--r--
[doc] document debug toolbar
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12096
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
     1
Pyramid
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
     2
=======
11537
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     3
12096
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
     4
:mod:`cubicweb.pyramid` provides a way to bind a CubicWeb data repository to a
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
     5
Pyramid WSGI web application.
11537
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     6
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     7
It can be used in two different ways:
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     8
12096
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
     9
-   Through the :ref:`pyramid command <cubicweb-ctl_pyramid>` or through
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
    10
    :func:`cubicweb.pyramid.wsgi_application` WSGI application factory, one can
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
    11
    run an ``all-in-one`` CubicWeb instance with the web part served by a
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
    12
    Pyramid application. This is referred to as the *backwards compatible
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
    13
    mode*.
11537
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    14
12096
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
    15
-   Through the ``pyramid`` configuration type, one can setup a CubicWeb
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
    16
    instance which repository can be used from within a Pyramid application.
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
    17
    Such an instance may be launched through ``pserve`` or any WSGI server as
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
    18
    would any plain Pyramid application.
b8bfcab1a91c [doc] Rewrite "pyramid" index page in the book
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12093
diff changeset
    19
11537
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    20
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    21
Narrative Documentation
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    22
=======================
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    23
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    24
.. toctree::
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    25
    :maxdepth: 2
12093
fa341698ac9c [doc] Remove trailing whitespaces in doc/book/pyramid/index.rst
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11631
diff changeset
    26
11631
faf279e33298 Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents: 11565
diff changeset
    27
    quickstart
faf279e33298 Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents: 11565
diff changeset
    28
    ctl
faf279e33298 Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents: 11565
diff changeset
    29
    settings
faf279e33298 Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents: 11565
diff changeset
    30
    auth
faf279e33298 Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents: 11565
diff changeset
    31
    profiling
12819
053329493511 [doc] document debug toolbar
Laurent Peuch <cortex@worlddomination.be>
parents: 12096
diff changeset
    32
    debug_toolbar
11537
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    33
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    34
Api Documentation
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    35
=================
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    36
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    37
.. toctree::
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    38
    :maxdepth: 2
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    39
    :glob:
caf268942436 Initial documentation.
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    40
11631
faf279e33298 Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents: 11565
diff changeset
    41
    ../../api/pyramid