docs/index.rst
changeset 11537 caf268942436
child 11541 732b00868f00
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/index.rst	Sat Jan 03 22:06:03 2015 +0100
@@ -0,0 +1,45 @@
+================
+Pyramid Cubicweb
+================
+
+Pyramid Cubicweb is an attempt to rebase the CubicWeb_ framework on pyramid.
+
+It can be used in two different ways:
+
+-   Within CubicWeb, through the 'pyramid' cube and the
+    :ref:`pyramid command <cubicweb-ctl_pyramid>`.
+    In this mode, the Pyramid CubicWeb replaces some parts of
+    CubicWeb and make the pyramid api available to the cubes.
+
+-   Within a pyramid application, it provides easy access to a CubicWeb
+    instance and registry.
+
+Narrative Documentation
+=======================
+
+.. toctree::
+    :maxdepth: 2
+    
+    narr/quickstart
+    narr/ctl
+    narr/settings
+    narr/profiling
+
+Api Documentation
+=================
+
+.. toctree::
+    :maxdepth: 2
+    :glob:
+
+    api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+.. _CubicWeb: http://www.cubicweb.org/