doc/index.rst
author Philippe Pepiot <ph@itsalwaysdns.eu>
Tue, 31 Mar 2020 19:15:03 +0200
changeset 12957 0c973204033a
parent 12863 f725078656bd
permissions -rw-r--r--
[server] prevent returning closed cursor to the database pool In since c8c6ad8 init_repository use repo.internal_cnx() instead of repo.system_source.get_connection() so it use the pool and we should not close cursors from the pool before returning it back. Otherwise we may have "connection already closed" error. This bug only trigger when connection-pool-size = 1. Since we are moving to use a dynamic pooler we need to get this fixed. This does not occur with sqlite since the connection wrapper instantiate new cursor everytime, but this occur with other databases.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     1
=====================================================
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     2
|cubicweb| - The Semantic Web is a construction game!
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     3
=====================================================
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     4
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     5
|cubicweb| is a semantic web application framework, licensed under the LGPL,
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     6
that empowers developers to efficiently build web applications by reusing
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     7
components (called `cubes`) and following the well known object-oriented design
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     8
principles.
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     9
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    10
Main Features
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    11
~~~~~~~~~~~~~
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    12
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    13
* an engine driven by the explicit :ref:`data model
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    14
  <TutosBaseCustomizingTheApplicationDataModel>` of the application,
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    15
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    16
* a query language named :ref:`RQL <RQL>` similar to W3C's SPARQL,
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    17
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    18
* a :ref:`selection+view <TutosBaseCustomizingTheApplicationCustomViews>`
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    19
  mechanism for semi-automatic XHTML/XML/JSON/text generation,
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    20
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    21
* a library of reusable :ref:`components <Cube>` (data model and views) that
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    22
  fulfill common needs,
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    23
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    24
* the power and flexibility of the Python_ programming language,
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    25
12853
48e066c9655a [doc] remove Subversion mentions
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 12816
diff changeset
    26
* the reliability of SQL databases, LDAP directories and Mercurial
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    27
  for storage backends.
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    28
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    29
Built since 2000 from an R&D effort still continued, supporting 100,000s of
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    30
daily visits at some production sites, |cubicweb| is a proven end to end solution
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    31
for semantic web application development that promotes quality, reusability and
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    32
efficiency.
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    33
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    34
QuickStart
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    35
~~~~~~~~~~
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    36
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    37
The impatient developer will move right away to :ref:`SetUpEnv` then to :ref:`ConfigEnv`.
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    38
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    39
Social
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    40
~~~~~~
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    41
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    42
*   Chat on the `jabber forum`_
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    43
*   Discuss on the `mailing-list`_
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    44
*   Discover on the `blog`_
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    45
*   Contribute on the forge_
12855
aed90f31f16e [doc] add links to pypi and npm
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 12853
diff changeset
    46
*   Find published python modules on `pypi <https://pypi.org/search/?q=cubicweb>`_
aed90f31f16e [doc] add links to pypi and npm
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 12853
diff changeset
    47
*   Find published npm modules on `npm <https://www.npmjs.com/search?q=keywords:cubicweb>`_
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    48
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    49
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    50
.. _Logilab: http://www.logilab.fr/
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    51
.. _forge: http://www.cubicweb.org/project/
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    52
.. _Python: http://www.python.org/
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    53
.. _`jabber forum`: http://www.logilab.org/blogentry/6718
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    54
.. _`mailing-list`: http://lists.cubicweb.org/mailman/listinfo/cubicweb
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    55
.. _blog: http://www.cubicweb.org/blog/1238
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    56
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    57
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    58
Narrative Documentation
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    59
~~~~~~~~~~~~~~~~~~~~~~~
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    60
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    61
A.k.a. "The Book"
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    62
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    63
.. toctree::
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    64
   :maxdepth: 2
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    65
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    66
   book/intro/index
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    67
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    68
.. toctree::
10500
d1164ba9ac23 [doc] put the tutorials between the intro and the `Repository development` toc of the book
David Douard <david.douard@logilab.fr>
parents: 10496
diff changeset
    69
   :maxdepth: 2
d1164ba9ac23 [doc] put the tutorials between the intro and the `Repository development` toc of the book
David Douard <david.douard@logilab.fr>
parents: 10496
diff changeset
    70
d1164ba9ac23 [doc] put the tutorials between the intro and the `Repository development` toc of the book
David Douard <david.douard@logilab.fr>
parents: 10496
diff changeset
    71
   tutorials/index
12792
e2cdb1be6bd9 [doc8] D002 Trailing whitespace
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 12380
diff changeset
    72
10500
d1164ba9ac23 [doc] put the tutorials between the intro and the `Repository development` toc of the book
David Douard <david.douard@logilab.fr>
parents: 10496
diff changeset
    73
.. toctree::
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    74
   :maxdepth: 3
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    75
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    76
   book/devrepo/index
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    77
   book/devweb/index
11631
faf279e33298 Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents: 10503
diff changeset
    78
   book/pyramid/index
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    79
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    80
.. toctree::
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    81
   :maxdepth: 2
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    82
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    83
   book/admin/index
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    84
   book/additionnal_services/index
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    85
   book/annexes/index
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    86
10496
e95b559a06a2 [doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents: 10494
diff changeset
    87
e95b559a06a2 [doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents: 10494
diff changeset
    88
e95b559a06a2 [doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents: 10494
diff changeset
    89
Changes
e95b559a06a2 [doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents: 10494
diff changeset
    90
~~~~~~~
e95b559a06a2 [doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents: 10494
diff changeset
    91
e95b559a06a2 [doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents: 10494
diff changeset
    92
.. toctree::
e95b559a06a2 [doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents: 10494
diff changeset
    93
   :maxdepth: 2
e95b559a06a2 [doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents: 10494
diff changeset
    94
10503
209738650200 [doc] make the changelog chapter a one html page
David Douard <david.douard@logilab.fr>
parents: 10500
diff changeset
    95
   changes/changelog
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    96
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    97
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    98
Reference documentation
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    99
~~~~~~~~~~~~~~~~~~~~~~~
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   100
10494
b6f00889355c [doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents: 10492
diff changeset
   101
API
b6f00889355c [doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents: 10492
diff changeset
   102
'''
b6f00889355c [doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents: 10492
diff changeset
   103
b6f00889355c [doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents: 10492
diff changeset
   104
.. toctree::
b6f00889355c [doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents: 10492
diff changeset
   105
    :maxdepth: 1
b6f00889355c [doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents: 10492
diff changeset
   106
    :glob:
b6f00889355c [doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents: 10492
diff changeset
   107
b6f00889355c [doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents: 10492
diff changeset
   108
    api/*
b6f00889355c [doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents: 10492
diff changeset
   109
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   110
.. toctree::
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   111
    :maxdepth: 1
12816
a119dc0d1cc5 [doc/fix] listing of js_api in index was broken
Laurent Peuch <cortex@worlddomination.be>
parents: 12792
diff changeset
   112
    :glob:
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   113
12816
a119dc0d1cc5 [doc/fix] listing of js_api in index was broken
Laurent Peuch <cortex@worlddomination.be>
parents: 12792
diff changeset
   114
    js_api/*
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   115
10492
68c13e0c0fc5 [doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents: 10491
diff changeset
   116
Developpers
68c13e0c0fc5 [doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents: 10491
diff changeset
   117
~~~~~~~~~~~
68c13e0c0fc5 [doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents: 10491
diff changeset
   118
68c13e0c0fc5 [doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents: 10491
diff changeset
   119
.. toctree::
68c13e0c0fc5 [doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents: 10491
diff changeset
   120
    :maxdepth: 1
68c13e0c0fc5 [doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents: 10491
diff changeset
   121
    :glob:
68c13e0c0fc5 [doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents: 10491
diff changeset
   122
12863
f725078656bd [doc/index] fix link to "how to contribute" and add link to dev dashboard
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 12855
diff changeset
   123
    How to contribute to the code base <https://hg.logilab.org/master/cubicweb/file/tip/README#l56>
12380
5efff873705e [doc] add link to cubes contribution document
Laurent Peuch <cortex@worlddomination.be>
parents: 12374
diff changeset
   124
    General contribution guide for cubes <https://www.logilab.org/Card/contributing>
12863
f725078656bd [doc/index] fix link to "how to contribute" and add link to dev dashboard
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 12855
diff changeset
   125
    Priorities are discussed over on the development dashboard <https://www.cubicweb.org/card/cw-dev-board>
10492
68c13e0c0fc5 [doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents: 10491
diff changeset
   126
    dev/*
68c13e0c0fc5 [doc] Insert the dev docs in the toc
Christophe de Vienne <christophe@unlish.com>
parents: 10491
diff changeset
   127
10491
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   128
Indexes
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   129
~~~~~~~
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   130
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   131
* the :ref:`genindex`,
c67bcee93248 [doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
   132
* the :ref:`modindex`,