[doc] add list of dependencies in appendix stable
authorNicolas Chauvat <nicolas.chauvat@logilab.fr>
Sat, 18 Jul 2009 16:00:14 +0200
branchstable
changeset 2393 6190852af97f
parent 2392 4f6bfffbfb80
child 2394 92bba46b853f
[doc] add list of dependencies in appendix
doc/book/en/B000-development.en.txt
doc/book/en/admin/setup.rst
doc/book/en/annexes/depends.rst
doc/book/en/annexes/index.rst
doc/book/en/development/datamodel/index.rst
doc/book/en/development/datamodel/inheritance.rst
--- a/doc/book/en/B000-development.en.txt	Fri Jul 17 20:25:06 2009 +0200
+++ b/doc/book/en/B000-development.en.txt	Sat Jul 18 16:00:14 2009 +0200
@@ -1,7 +1,5 @@
 .. -*- coding: utf-8 -*-
 
-.. _Part2:
-
 =====================
 Part II - Development
 =====================
--- a/doc/book/en/admin/setup.rst	Fri Jul 17 20:25:06 2009 +0200
+++ b/doc/book/en/admin/setup.rst	Sat Jul 18 16:00:14 2009 +0200
@@ -47,12 +47,12 @@
 There is also a wide variety of cubes listed on http://www.cubicweb.org/Project available as debian packages and tarball.
 
 The repositories are signed with `Logilab's gnupg key`_. To avoid warning on "apt-get update":
-1. become root using sudo 
+1. become root using sudo
 2. download http://ftp.logilab.org/dists/logilab-dists-key.asc using e.g. wget
 3. run "apt-key add logilab-dists-key.asc"
 4. re-run apt-get update (manually or through the package manager, whichever you prefer)
 
-.. `Logilab's gnupg key` _http://ftp.logilab.org/dists/logilab-dists-key.asc
+.. _`Logilab's gnupg key`: http://ftp.logilab.org/dists/logilab-dists-key.asc
 
 Install from source
 ```````````````````
@@ -70,6 +70,9 @@
 
 See :ref:`MercurialPresentation` for more details about Mercurial.
 
+In both cases, make sure you have installed the dependencies (see appendixes for
+the list).
+
 Postgres installation
 `````````````````````
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/book/en/annexes/depends.rst	Sat Jul 18 16:00:14 2009 +0200
@@ -0,0 +1,48 @@
+.. -*- coding: utf-8 -*-
+
+.. _dependencies:
+
+Dependencies
+============
+
+When you run CubicWeb from source, either by downloading the tarball or
+cloning the mercurial forest, here is the list of tools and libraries you need
+to have installed in order for CubicWeb to work:
+
+* mxDateTime - http://www.egenix.com/products/python/mxBase/mxDateTime/ - http://pypi.python.org/pypi/egenix-mx-base
+
+* pyro - http://pyro.sourceforge.net/ - http://pypi.python.org/pypi/Pyro
+
+* yapps - http://theory.stanford.edu/~amitp/yapps/ -
+  http://pypi.python.org/pypi/Yapps2
+
+* pygraphviz - http://networkx.lanl.gov/pygraphviz/ -
+  http://pypi.python.org/pypi/pygraphviz
+
+* simplejson - http://code.google.com/p/simplejson/ -
+  http://pypi.python.org/pypi/simplejson
+
+* lxml - http://codespeak.net/lxml - http://pypi.python.org/pypi/lxml
+
+* twisted - http://twistedmatrix.com/ - http://pypi.python.org/pypi/Twisted
+
+* logilab-common - http://www.logilab.org/project/logilab-common -
+  http://pypi.python.org/pypi/logilab-common/ - included in the forest
+
+* logilab-constraint - http://www.logilab.org/project/logilab-constraint -
+  http://pypi.python.org/pypi/constraint/ - included in the forest
+
+* logilab-mtconverter - http://www.logilab.org/project/logilab-mtconverter -
+  http://pypi.python.org/pypi/logilab-mtconverter - included in the forest
+
+* rql - http://www.logilab.org/project/rql - http://pypi.python.org/pypi/rql -
+  included in the forest
+
+* yams - http://www.logilab.org/project/yams - http://pypi.python.org/pypi/yams
+  - included in the forest
+
+* indexer - http://www.logilab.org/project/indexer -
+  http://pypi.python.org/pypi/indexer - included in the forest
+
+Any help with the packaging of CubicWeb for more than Debian/Ubuntu (including
+eggs, buildouts, etc) will be greatly appreciated.
--- a/doc/book/en/annexes/index.rst	Fri Jul 17 20:25:06 2009 +0200
+++ b/doc/book/en/annexes/index.rst	Sat Jul 18 16:00:14 2009 +0200
@@ -16,6 +16,7 @@
    cubicweb-ctl
    rql/index
    mercurial
+   depends
 
 (X)HTML tricks to apply
 -----------------------
--- a/doc/book/en/development/datamodel/index.rst	Fri Jul 17 20:25:06 2009 +0200
+++ b/doc/book/en/development/datamodel/index.rst	Sat Jul 18 16:00:14 2009 +0200
@@ -9,6 +9,5 @@
    definition
    metadata
    baseschema
-
-..    define-workflows
-..    inheritance
+   define-workflows
+   inheritance
--- a/doc/book/en/development/datamodel/inheritance.rst	Fri Jul 17 20:25:06 2009 +0200
+++ b/doc/book/en/development/datamodel/inheritance.rst	Sat Jul 18 16:00:14 2009 +0200
@@ -1,1 +1,5 @@
-XXX WRITME
\ No newline at end of file
+
+Inheritance
+-----------
+
+XXX WRITME