From 67d145b356048c61d9af6c140d60894425b5410f Mon Sep 17 00:00:00 2001
From: Anael Beutot <anael.beutot@smartjog.com>
Date: Fri, 20 Jul 2012 16:29:34 +0200
Subject: [PATCH] Updated documentation
---
docs/dev/source/architecture.rst | 8 +-----
docs/dev/source/cold_migration.rst | 4 +++
docs/dev/source/exc.rst | 5 ++++
docs/dev/source/host.rst | 11 ++++----
.../{migration.rst => hot_migration.rst} | 0
docs/dev/source/hypervisor.rst | 24 ++++++++++++++++-
docs/dev/source/index.rst | 10 ++++++-
docs/dev/source/jobs.rst | 26 +++++++++++++++++++
docs/dev/source/libvirt.rst | 5 ++++
docs/dev/source/plugins.rst | 5 ++++
docs/dev/source/tags.rst | 5 ++++
docs/dev/source/utils.rst | 5 ++++
docs/dev/source/vm.rst | 14 ++++++++++
13 files changed, 107 insertions(+), 15 deletions(-)
create mode 100644 docs/dev/source/cold_migration.rst
create mode 100644 docs/dev/source/exc.rst
rename docs/dev/source/{migration.rst => hot_migration.rst} (100%)
create mode 100644 docs/dev/source/jobs.rst
create mode 100644 docs/dev/source/libvirt.rst
create mode 100644 docs/dev/source/plugins.rst
create mode 100644 docs/dev/source/tags.rst
create mode 100644 docs/dev/source/utils.rst
create mode 100644 docs/dev/source/vm.rst
diff --git a/docs/dev/source/architecture.rst b/docs/dev/source/architecture.rst
index 428532b..f876008 100644
--- a/docs/dev/source/architecture.rst
+++ b/docs/dev/source/architecture.rst
@@ -32,6 +32,7 @@ Organisation of modules/packages
| | |-- __init__.py
| | |-- vm_tags.py
| |-- __init__.py
+ | |-- jobs.py
| |-- lib.py
| |-- tags.py
|-- __init__.py
@@ -48,10 +49,3 @@ Node
.. automodule:: cloudcontrol.node.node
:members:
-
-Tags
-----
-
-.. automodule:: cloudcontrol.node.tags
- :members:
-
diff --git a/docs/dev/source/cold_migration.rst b/docs/dev/source/cold_migration.rst
new file mode 100644
index 0000000..43862ff
--- /dev/null
+++ b/docs/dev/source/cold_migration.rst
@@ -0,0 +1,4 @@
+Cold migration steps
+====================
+
+TODO
diff --git a/docs/dev/source/exc.rst b/docs/dev/source/exc.rst
new file mode 100644
index 0000000..77af395
--- /dev/null
+++ b/docs/dev/source/exc.rst
@@ -0,0 +1,5 @@
+Exceptions
+==========
+
+.. automodule:: cloudcontrol.node.exc
+ :members:
diff --git a/docs/dev/source/host.rst b/docs/dev/source/host.rst
index 361150c..8bef70a 100644
--- a/docs/dev/source/host.rst
+++ b/docs/dev/source/host.rst
@@ -1,15 +1,14 @@
Host
====
-Tags
-----
-
-.. automodule:: cloudcontrol.node.host.tags
- :members:
-
Handler
-------
.. autoclass:: cloudcontrol.node.host.Handler
:members:
+Tags
+----
+
+.. automodule:: cloudcontrol.node.host.tags
+ :members:
diff --git a/docs/dev/source/migration.rst b/docs/dev/source/hot_migration.rst
similarity index 100%
rename from docs/dev/source/migration.rst
rename to docs/dev/source/hot_migration.rst
diff --git a/docs/dev/source/hypervisor.rst b/docs/dev/source/hypervisor.rst
index ff9a53f..a23276c 100644
--- a/docs/dev/source/hypervisor.rst
+++ b/docs/dev/source/hypervisor.rst
@@ -1,4 +1,26 @@
Hypervisor
==========
-TODO
+Hypervisor handler
+------------------
+
+.. autoclass:: cloudcontrol.node.hypervisor.Handler
+ :members:
+
+Hypervisor object
+-----------------
+
+.. autoclass:: cloudcontrol.node.hypervisor.Hypervisor
+ :members:
+
+Storage pools and volumes
+-------------------------
+
+.. autoclass:: cloudcontrol.node.hypervisor.StorageIndex
+ :members:
+
+.. autoclass:: cloudcontrol.node.hypervisor.Storage
+ :members:
+
+.. autoclass:: cloudcontrol.node.hypervisor.Volume
+ :members:
diff --git a/docs/dev/source/index.rst b/docs/dev/source/index.rst
index 8f29e69..70d1473 100644
--- a/docs/dev/source/index.rst
+++ b/docs/dev/source/index.rst
@@ -12,10 +12,18 @@ Contents:
:maxdepth: 2
architecture
+ tags
+ plugins
host
+ libvirt
hypervisor
- migration
+ vm
+ jobs
+ cold_migration
+ hot_migration
test
+ exc
+ utils
Indices and tables
==================
diff --git a/docs/dev/source/jobs.rst b/docs/dev/source/jobs.rst
new file mode 100644
index 0000000..97e8a54
--- /dev/null
+++ b/docs/dev/source/jobs.rst
@@ -0,0 +1,26 @@
+Jobs
+====
+
+Jobs manager
+------------
+
+.. autoclass:: cloudcontrol.node.jobs.JobManager
+ :members:
+
+Abstract jobs
+-------------
+
+.. autoclass:: cloudcontrol.node.jobs.BaseThreadedJob
+ :members:
+
+.. autoclass:: cloudcontrol.node.jobs.ForkedJob
+ :members:
+
+.. autoclass:: cloudcontrol.node.jobs.BaseIOJob
+ :members:
+
+Hypervisor jobs
+---------------
+
+.. automodule:: cloudcontrol.node.hypervisor.jobs
+ :members:
diff --git a/docs/dev/source/libvirt.rst b/docs/dev/source/libvirt.rst
new file mode 100644
index 0000000..63ca4b3
--- /dev/null
+++ b/docs/dev/source/libvirt.rst
@@ -0,0 +1,5 @@
+Libvirt
+=======
+
+.. automodule:: cloudcontrol.node.hypervisor.lib
+ :members:
diff --git a/docs/dev/source/plugins.rst b/docs/dev/source/plugins.rst
new file mode 100644
index 0000000..0c587a8
--- /dev/null
+++ b/docs/dev/source/plugins.rst
@@ -0,0 +1,5 @@
+Plugins
+=======
+
+.. automodule:: cloudcontrol.node.plugins
+ :members:
diff --git a/docs/dev/source/tags.rst b/docs/dev/source/tags.rst
new file mode 100644
index 0000000..8c4a387
--- /dev/null
+++ b/docs/dev/source/tags.rst
@@ -0,0 +1,5 @@
+Tags
+====
+
+.. automodule:: cloudcontrol.node.tags
+ :members:
diff --git a/docs/dev/source/utils.rst b/docs/dev/source/utils.rst
new file mode 100644
index 0000000..783c6eb
--- /dev/null
+++ b/docs/dev/source/utils.rst
@@ -0,0 +1,5 @@
+Utils
+=====
+
+.. automodule:: cloudcontrol.node.utils
+ :members:
diff --git a/docs/dev/source/vm.rst b/docs/dev/source/vm.rst
new file mode 100644
index 0000000..d15d041
--- /dev/null
+++ b/docs/dev/source/vm.rst
@@ -0,0 +1,14 @@
+Domains
+=======
+
+KVM virtual machines
+--------------------
+
+.. automodule:: cloudcontrol.node.hypervisor.domains
+ :members:
+
+KVM tags
+--------
+
+.. automodule:: cloudcontrol.node.hypervisor.domains.vm_tags
+ :members:
--
GitLab