Merge branch 'master' of https://code.grnet.gr/git/synnefo

docs/conf.py

@@ -37,6 +37,7 @@ for name, ver in SYNNEFO_PROJECTS.iteritems():
                                                  '%s/%s/' % (name, ver),
                                  None)
 
-extensions = ['sphinx.ext.intersphinx',
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.intersphinx',
               'sphinx.ext.todo',
               'sphinx.ext.viewcode']

docs/cyclades-api-guide.rst

+.. _cyclades-api-guide:
+
 API Guide
 *********
 

docs/dev-guide.rst

@@ -34,12 +34,20 @@ This is the Cyclades Compute API:
 Network API (Cyclades)
 ======================
 
-Network API body
+The Network API is currently implemented inside Cyclades. Please consult the
+:ref:`Compute API <cyclades-api-guide>` for more details.
+
 
 Images API (Plankton)
 =====================
 
-Images API body
+This is the Plankton Image API:
+
+.. toctree::
+   :maxdepth: 2
+
+   Image API <plankton-api-guide>
+
 
 Storage API (Pithos+)
 =====================

docs/index.rst

@@ -73,19 +73,20 @@ synnefo services. All components are released as:
 
 They are also available from our apt repository: ``apt.okeanos.grnet.gr``
 
- * snf-common
- * snf-webproject
- * snf-astakos-app
- * snf-pithos-backend
- * snf-pithos-app
- * snf-pithos-tools
- * snf-pithos-webclient
- * snf-cyclades-app
- * snf-cyclades-gtools
- * snf-vncauthproxy
- * snf-image
- * snf-cloudcms
- * nfdhcpd
+ * `snf-common <http://docs.dev.grnet.gr/snf-common/latest/index.html>`_
+ * `snf-webproject <http://docs.dev.grnet.gr/snf-webproject/latest/index.html>`_
+ * `snf-astakos-app <http://docs.dev.grnet.gr/astakos/latest/index.html>`_
+ * `snf-pithos-backend <http://docs.dev.grnet.gr/pithos/latest/backends.html>`_
+ * `snf-pithos-app <http://docs.dev.grnet.gr/pithos/latest/index.html>`_
+ * `snf-pithos-tools <http://docs.dev.grnet.gr/pithos/latest/index.html>`_
+ * `snf-pithos-webclient <http://docs.dev.grnet.gr/pithos-webclient/latest/index.html>`_
+ * `snf-cyclades-app <http://docs.dev.grnet.gr/snf-cyclades-app/latest/index.html>`_
+ * `snf-cyclades-gtools <http://docs.dev.grnet.gr/snf-cyclades-gtools/latest/index.html>`_
+ * `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_
+ * `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ 
+ * `snf-occi <http://docs.dev.grnet.gr/snf-occi/latest/index.html>`_
+ * `snf-cloudcms <http://docs.dev.grnet.gr/snf-cloudcms/latest/index.html>`_
+ * `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_
 
 
 Contact

docs/plankton-api-guide.rst

+.. _cyclades-api-guide:
+
+Plankton API Guide
+^^^^^^^^^^^^^^^^^^
+
+.. automodule:: synnefo.plankton.views
+    :members:
+    :show-inheritance:
+    :undoc-members:

docs/plankton.rst

@@ -8,15 +8,23 @@ Introduction
 
 Plankton is the synnefo Image Registry Service. It is implemented as a very thin
 layer on top of Pithos+; every Image on Plankton is a file on a Pithos+ backend,
-with special metadata. At the frontend, Plankton implements the OpenStack Glance
-API; at the backend it queries an existing Pithos+ backend. In the current
-implementation the service runs Plankton and Pithos+ on a single, unified
-backend: users may synchronize their Images, using the Pithos+ clients, then
-register them with Plankton, with zero data movement. Then spaw new VMs from 
-those images with Cyclades.
+with special metadata. At the frontend, Plankton implements the OpenStack
+Glance API; at the backend it queries an existing Pithos+ backend. In the
+current implementation the service runs Plankton and Pithos+ on a single,
+unified backend: users may synchronize their Images, using the Pithos+ clients,
+then register them with Plankton, with zero data movement. Then spawn new VMs
+from those images with Cyclades.
+
+Let's see below:
+
 
 .. image:: images/synnefo-clonepath.png
 
+The figure shows a sailor bundling his physical machine with the
+``snf-image-creator`` tool, uploading the file to pithos+, registering the file
+as a new image with plankton and then spawning two new VMs with Cyclades from
+this image.
+
 The :ref:`Plankton API <plankton-api-guide>` is implemented inside Cyclades, so please consult the
 :ref:`Cyclades Documentation <cyclades>` for more details.