summaryrefslogtreecommitdiffstats
path: root/doc/source
diff options
context:
space:
mode:
authorTodd Willey <todd@ansolabs.com>2010-11-02 18:05:47 -0400
committerTodd Willey <todd@ansolabs.com>2010-11-02 18:05:47 -0400
commite493e324eb9a9fe31e72551b34bab768b507bc1d (patch)
tree225e11521aa9100332f64cabccb593cf9440973d /doc/source
parent56c22eab57bc1096c0cd7e6756b42d163649fae1 (diff)
Document final undocumented python modules.
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/api.rst108
-rw-r--r--doc/source/cloudpipe.rst27
-rw-r--r--doc/source/compute.rst8
-rw-r--r--doc/source/development.guide.rst3
-rw-r--r--doc/source/glance.rst27
-rw-r--r--doc/source/network.rst11
-rw-r--r--doc/source/nova.rst83
-rw-r--r--doc/source/objectstore.rst62
-rw-r--r--doc/source/scheduler.rst11
9 files changed, 339 insertions, 1 deletions
diff --git a/doc/source/api.rst b/doc/source/api.rst
index 3f1c69a15..0908d9e57 100644
--- a/doc/source/api.rst
+++ b/doc/source/api.rst
@@ -161,3 +161,111 @@ The :mod:`metadatarequesthandler` Module
:members:
:undoc-members:
:show-inheritance:
+
+Tests
+-----
+
+The :mod:`api_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`api_integration` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api_integration
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`cloud_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.cloud_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`api.fakes` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.fakes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`api.test_wsgi` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.test_wsgi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`test_api` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.openstack.test_api
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`test_auth` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.openstack.test_auth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`test_faults` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.openstack.test_faults
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`test_flavors` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.openstack.test_flavors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`test_images` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.openstack.test_images
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`test_ratelimiting` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.openstack.test_ratelimiting
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`test_servers` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.openstack.test_servers
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`test_sharedipgroups` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.api.openstack.test_sharedipgroups
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/doc/source/cloudpipe.rst b/doc/source/cloudpipe.rst
new file mode 100644
index 000000000..f2e7cb85a
--- /dev/null
+++ b/doc/source/cloudpipe.rst
@@ -0,0 +1,27 @@
+..
+ Copyright 2010 United States Government as represented by the
+ Administrator of the National Aeronautics and Space Administration.
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Cloudpipe Programmer Guide
+==========================
+
+The :mod:`pipelib` Module
+-------------------------
+
+.. automodule:: nova.cloudpipe.pipelib
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/compute.rst b/doc/source/compute.rst
index e9e37ebf8..ff6aeab92 100644
--- a/doc/source/compute.rst
+++ b/doc/source/compute.rst
@@ -135,7 +135,6 @@ The :mod:`monitor` Module
Tests
-----
-
The :mod:`compute_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -144,3 +143,10 @@ The :mod:`compute_unittest` Module
:undoc-members:
:show-inheritance:
+The :mod:`virt_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.virt_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/development.guide.rst b/doc/source/development.guide.rst
index 261059d9b..306decccb 100644
--- a/doc/source/development.guide.rst
+++ b/doc/source/development.guide.rst
@@ -40,6 +40,9 @@ Contents
scheduler
fakes
nova
+ cloudpipe
+ objectstore
+ glance
Indices and tables
diff --git a/doc/source/glance.rst b/doc/source/glance.rst
new file mode 100644
index 000000000..3d0f4ebec
--- /dev/null
+++ b/doc/source/glance.rst
@@ -0,0 +1,27 @@
+..
+ Copyright 2010 United States Government as represented by the
+ Administrator of the National Aeronautics and Space Administration.
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Glance Integration Programming Guide
+====================================
+
+The :mod:`image.service` Module
+-------------------------------
+
+.. automodule:: nova.image.service
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/network.rst b/doc/source/network.rst
index b044c6413..cbff22d3f 100644
--- a/doc/source/network.rst
+++ b/doc/source/network.rst
@@ -43,6 +43,17 @@ The :mod:`LinuxNet` driver
:undoc-members:
:show-inheritance:
+Tests
+-----
+
+The :mod:`network_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.network_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
legacy docs
-----------
diff --git a/doc/source/nova.rst b/doc/source/nova.rst
index 59fd56c85..17d32c010 100644
--- a/doc/source/nova.rst
+++ b/doc/source/nova.rst
@@ -145,3 +145,86 @@ The :mod:`wsgi` Module
:members:
:undoc-members:
:show-inheritance:
+
+Tests
+-----
+
+The :mod:`declare_flags` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.declare_flags
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`fake_flags` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.fake_flags
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`flags_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.flags_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`process_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.process_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`quota_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.quota_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`real_flags` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.real_flags
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`rpc_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.rpc_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`runtime_flags` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.runtime_flags
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`twistd_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.twistd_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`validator_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.validator_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/objectstore.rst b/doc/source/objectstore.rst
new file mode 100644
index 000000000..4087b5dd0
--- /dev/null
+++ b/doc/source/objectstore.rst
@@ -0,0 +1,62 @@
+..
+ Copyright 2010 United States Government as represented by the
+ Administrator of the National Aeronautics and Space Administration.
+ All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+Objectstore Programming Guide
+=============================
+
+The :mod:`handler` Module
+-------------------------
+
+.. automodule:: nova.objectstore.handler
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`bucket` Module
+------------------------
+
+.. automodule:: nova.objectstore.bucket
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`stored` Module
+------------------------
+
+.. automodule:: nova.objectstore.stored
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+The :mod:`image` Module
+-----------------------
+
+.. automodule:: nova.objectstore.image
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Tests
+-----
+
+The :mod:`objectstore_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.objectstore_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/scheduler.rst b/doc/source/scheduler.rst
index e809b0c54..df820c2f2 100644
--- a/doc/source/scheduler.rst
+++ b/doc/source/scheduler.rst
@@ -49,3 +49,14 @@ The :mod:`simple` Module
:members:
:undoc-members:
:show-inheritance:
+
+Tests
+-----
+
+The :mod:`scheduler_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.scheduler_unittest
+ :members:
+ :undoc-members:
+ :show-inheritance: