openstack/nova
Code Issues Proposed changes

Cleanups to doc process.

Browse Source
This commit is contained in:
Todd Willey 2010-11-07 15:14:58 -05:00
parent 913d078469
commit 7a501be599
12 changed files with 137 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
doc/generate_autodoc_index.sh Normal file → Executable file
View File

31
doc/source/devref/api.rst
View File

@ -27,8 +27,8 @@ Common Components
The :mod:`nova.api` Module The :mod:`nova.api` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api .. automodule:: nova.api
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -37,6 +37,7 @@ The :mod:`nova.api.cloud` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.cloud .. automodule:: nova.api.cloud
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -47,6 +48,7 @@ OpenStack API
The :mod:`openstack` Module The :mod:`openstack` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.openstack .. automodule:: nova.api.openstack
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -54,6 +56,7 @@ The :mod:`openstack` Module
The :mod:`auth` Module The :mod:`auth` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.openstack.auth .. automodule:: nova.api.openstack.auth
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -61,6 +64,7 @@ The :mod:`auth` Module
The :mod:`backup_schedules` Module The :mod:`backup_schedules` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.openstack.backup_schedules .. automodule:: nova.api.openstack.backup_schedules
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -68,6 +72,7 @@ The :mod:`backup_schedules` Module
The :mod:`faults` Module The :mod:`faults` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.openstack.faults .. automodule:: nova.api.openstack.faults
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -75,6 +80,7 @@ The :mod:`faults` Module
The :mod:`flavors` Module The :mod:`flavors` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.openstack.flavors .. automodule:: nova.api.openstack.flavors
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -82,6 +88,7 @@ The :mod:`flavors` Module
The :mod:`images` Module The :mod:`images` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.openstack.images .. automodule:: nova.api.openstack.images
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -89,6 +96,7 @@ The :mod:`images` Module
The :mod:`ratelimiting` Module The :mod:`ratelimiting` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.openstack.ratelimiting .. automodule:: nova.api.openstack.ratelimiting
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -96,6 +104,7 @@ The :mod:`ratelimiting` Module
The :mod:`servers` Module The :mod:`servers` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.openstack.servers .. automodule:: nova.api.openstack.servers
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -103,6 +112,7 @@ The :mod:`servers` Module
The :mod:`sharedipgroups` Module The :mod:`sharedipgroups` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.openstack.sharedipgroups .. automodule:: nova.api.openstack.sharedipgroups
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -114,6 +124,7 @@ The :mod:`nova.api.ec2` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.ec2 .. automodule:: nova.api.ec2
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -122,6 +133,7 @@ The :mod:`admin` Module
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.ec2.admin .. automodule:: nova.api.ec2.admin
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -130,6 +142,7 @@ The :mod:`apirequest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.ec2.apirequest .. automodule:: nova.api.ec2.apirequest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -138,6 +151,7 @@ The :mod:`cloud` Module
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.ec2.cloud .. automodule:: nova.api.ec2.cloud
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -146,6 +160,7 @@ The :mod:`images` Module
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.ec2.images .. automodule:: nova.api.ec2.images
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -154,6 +169,7 @@ The :mod:`metadatarequesthandler` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.ec2.metadatarequesthandler .. automodule:: nova.api.ec2.metadatarequesthandler
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -165,6 +181,7 @@ The :mod:`api_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api_unittest .. automodule:: nova.tests.api_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -173,6 +190,7 @@ The :mod:`api_integration` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api_integration .. automodule:: nova.tests.api_integration
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -181,6 +199,7 @@ The :mod:`cloud_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.cloud_unittest .. automodule:: nova.tests.cloud_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -189,6 +208,7 @@ The :mod:`api.fakes` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.fakes .. automodule:: nova.tests.api.fakes
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -197,6 +217,7 @@ The :mod:`api.test_wsgi` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.test_wsgi .. automodule:: nova.tests.api.test_wsgi
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -205,6 +226,7 @@ The :mod:`test_api` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.openstack.test_api .. automodule:: nova.tests.api.openstack.test_api
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -213,6 +235,7 @@ The :mod:`test_auth` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.openstack.test_auth .. automodule:: nova.tests.api.openstack.test_auth
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -221,6 +244,7 @@ The :mod:`test_faults` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.openstack.test_faults .. automodule:: nova.tests.api.openstack.test_faults
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -229,6 +253,7 @@ The :mod:`test_flavors` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.openstack.test_flavors .. automodule:: nova.tests.api.openstack.test_flavors
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -237,6 +262,7 @@ The :mod:`test_images` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.openstack.test_images .. automodule:: nova.tests.api.openstack.test_images
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -245,6 +271,7 @@ The :mod:`test_ratelimiting` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.openstack.test_ratelimiting .. automodule:: nova.tests.api.openstack.test_ratelimiting
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -253,6 +280,7 @@ The :mod:`test_servers` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.openstack.test_servers .. automodule:: nova.tests.api.openstack.test_servers
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -261,6 +289,7 @@ The :mod:`test_sharedipgroups` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.api.openstack.test_sharedipgroups .. automodule:: nova.tests.api.openstack.test_sharedipgroups
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

18
doc/source/devref/auth.rst
View File

@ -21,18 +21,20 @@ Authentication and Authorization
================================ ================================
The :mod:`nova.quota` Module The :mod:`nova.quota` Module
----------------------- ----------------------------
.. automodule:: nova.quota .. automodule:: nova.quota
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.auth.signer` Module The :mod:`nova.auth.signer` Module
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.auth.signer .. automodule:: nova.auth.signer
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -42,26 +44,29 @@ Auth Manager
------------ ------------
The :mod:`nova.auth.manager` Module The :mod:`nova.auth.manager` Module
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.auth.manager .. automodule:: nova.auth.manager
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.auth.ldapdriver` Driver The :mod:`nova.auth.ldapdriver` Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.auth.ldapdriver .. automodule:: nova.auth.ldapdriver
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.auth.dbdriver` Driver The :mod:`nova.auth.dbdriver` Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.auth.dbdriver .. automodule:: nova.auth.dbdriver
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -75,6 +80,7 @@ The :mod:`auth_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.auth_unittest .. automodule:: nova.tests.auth_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -84,6 +90,7 @@ The :mod:`access_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.access_unittest .. automodule:: nova.tests.access_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -93,6 +100,7 @@ The :mod:`quota_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.quota_unittest .. automodule:: nova.tests.quota_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

26
doc/source/devref/compute.rst
View File

@ -28,51 +28,57 @@ a specific virtualization backend, read Drivers_.
The :mod:`nova.compute.manager` Module The :mod:`nova.compute.manager` Module
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.compute.manager .. automodule:: nova.compute.manager
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.virt.connection` Module The :mod:`nova.virt.connection` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.virt.connection .. automodule:: nova.virt.connection
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.compute.disk` Module The :mod:`nova.compute.disk` Module
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.compute.disk .. automodule:: nova.compute.disk
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.virt.images` Module The :mod:`nova.virt.images` Module
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.virt.images .. automodule:: nova.virt.images
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.compute.instance_types` Module The :mod:`nova.compute.instance_types` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.compute.instance_types .. automodule:: nova.compute.instance_types
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.compute.power_state` Module The :mod:`nova.compute.power_state` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.compute.power_state .. automodule:: nova.compute.power_state
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -86,6 +92,7 @@ The :mod:`nova.virt.libvirt_conn` Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.virt.libvirt_conn .. automodule:: nova.virt.libvirt_conn
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -95,6 +102,7 @@ The :mod:`nova.virt.xenapi` Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.virt.xenapi .. automodule:: nova.virt.xenapi
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -104,6 +112,7 @@ The :mod:`nova.virt.fake` Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.virt.fake .. automodule:: nova.virt.fake
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -113,9 +122,10 @@ Monitoring
---------- ----------
The :mod:`nova.compute.monitor` Module The :mod:`nova.compute.monitor` Module
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.compute.monitor .. automodule:: nova.compute.monitor
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -128,6 +138,7 @@ The :mod:`compute_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.compute_unittest .. automodule:: nova.tests.compute_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -136,6 +147,7 @@ The :mod:`virt_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.virt_unittest .. automodule:: nova.tests.virt_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

6
doc/source/devref/database.rst
View File

@ -19,9 +19,10 @@ The Database Layer
================== ==================
The :mod:`nova.db.api` Module The :mod:`nova.db.api` Module
--------------------- -----------------------------
.. automodule:: nova.db.api .. automodule:: nova.db.api
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -34,11 +35,13 @@ The :mod:`nova.db.sqlalchemy.api` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.db.sqlalchemy.api .. automodule:: nova.db.sqlalchemy.api
:noindex:
The :mod:`nova.db.sqlalchemy.models` Module The :mod:`nova.db.sqlalchemy.models` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.db.sqlalchemy.models .. automodule:: nova.db.sqlalchemy.models
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -47,6 +50,7 @@ The :mod:`nova.db.sqlalchemy.session` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.db.sqlalchemy.session .. automodule:: nova.db.sqlalchemy.session
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

17
doc/source/devref/fakes.rst
View File

@ -25,46 +25,50 @@ fake implementations of various drivers let you get on with your day.
The :mod:`nova.virt.fake` Module The :mod:`nova.virt.fake` Module
--------------------------- --------------------------------
.. automodule:: nova.virt.fake .. automodule:: nova.virt.fake
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:noindex:
The :mod:`nova.auth.fakeldap` Module The :mod:`nova.auth.fakeldap` Module
-------------------------- ------------------------------------
.. automodule:: nova.auth.fakeldap .. automodule:: nova.auth.fakeldap
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.fakerabbit` Module The :mod:`nova.fakerabbit` Module
---------------------------- ---------------------------------
.. automodule:: nova.fakerabbit .. automodule:: nova.fakerabbit
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :class:`nova.volume.driver.FakeAOEDriver` Class The :class:`nova.volume.driver.FakeAOEDriver` Class
-------------------------------- ---------------------------------------------------
.. autoclass:: nova.volume.driver.FakeAOEDriver .. autoclass:: nova.volume.driver.FakeAOEDriver
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :class:`nova.tests.service_unittest.FakeManager` Class The :class:`nova.tests.service_unittest.FakeManager` Class
----------------------------------------------- ----------------------------------------------------------
.. autoclass:: nova.tests.service_unittest.FakeManager .. autoclass:: nova.tests.service_unittest.FakeManager
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -74,6 +78,7 @@ The :mod:`nova.tests.api.openstack.fakes` Module
------------------------------------------------ ------------------------------------------------
.. automodule:: nova.tests.api.openstack.fakes .. automodule:: nova.tests.api.openstack.fakes
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

3
doc/source/devref/glance.rst
View File

@ -19,9 +19,10 @@ Glance Integration - The Future of File Storage
=============================================== ===============================================
The :mod:`nova.image.service` Module The :mod:`nova.image.service` Module
------------------------------- ------------------------------------
.. automodule:: nova.image.service .. automodule:: nova.image.service
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

3
doc/source/devref/network.rst
View File

@ -28,6 +28,7 @@ The :mod:`nova.network.manager` Module
-------------------------------------- --------------------------------------
.. automodule:: nova.network.manager .. automodule:: nova.network.manager
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -36,6 +37,7 @@ The :mod:`nova.network.linux_net` Driver
---------------------------------------- ----------------------------------------
.. automodule:: nova.network.linux_net .. automodule:: nova.network.linux_net
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -47,6 +49,7 @@ The :mod:`network_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.network_unittest .. automodule:: nova.tests.network_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

45
doc/source/devref/nova.rst
View File

@ -23,108 +23,120 @@ very well yet.
The :mod:`nova.adminclient` Module The :mod:`nova.adminclient` Module
----------------------------- ----------------------------------
.. automodule:: nova.adminclient .. automodule:: nova.adminclient
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.context` Module The :mod:`nova.context` Module
------------------------- ------------------------------
.. automodule:: nova.context .. automodule:: nova.context
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.exception` Module The :mod:`nova.exception` Module
--------------------------- --------------------------------
.. automodule:: nova.exception .. automodule:: nova.exception
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.flags` Module The :mod:`nova.flags` Module
----------------------- ----------------------------
.. automodule:: nova.flags .. automodule:: nova.flags
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.process` Module The :mod:`nova.process` Module
------------------------- ------------------------------
.. automodule:: nova.process .. automodule:: nova.process
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.rpc` Module The :mod:`nova.rpc` Module
--------------------- --------------------------
.. automodule:: nova.rpc .. automodule:: nova.rpc
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.server` Module The :mod:`nova.server` Module
------------------------ -----------------------------
.. automodule:: nova.server .. automodule:: nova.server
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.test` Module The :mod:`nova.test` Module
---------------------- ---------------------------
.. automodule:: nova.test .. automodule:: nova.test
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.twistd` Module The :mod:`nova.twistd` Module
------------------------ -----------------------------
.. automodule:: nova.twistd .. automodule:: nova.twistd
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.utils` Module The :mod:`nova.utils` Module
----------------------- ----------------------------
.. automodule:: nova.utils .. automodule:: nova.utils
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.validate` Module The :mod:`nova.validate` Module
-------------------------- -------------------------------
.. automodule:: nova.validate .. automodule:: nova.validate
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.wsgi` Module The :mod:`nova.wsgi` Module
---------------------- ---------------------------
.. automodule:: nova.wsgi .. automodule:: nova.wsgi
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -137,6 +149,7 @@ The :mod:`declare_flags` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.declare_flags .. automodule:: nova.tests.declare_flags
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -146,6 +159,7 @@ The :mod:`fake_flags` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.fake_flags .. automodule:: nova.tests.fake_flags
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -155,6 +169,7 @@ The :mod:`flags_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.flags_unittest .. automodule:: nova.tests.flags_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -164,6 +179,7 @@ The :mod:`process_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.process_unittest .. automodule:: nova.tests.process_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -173,6 +189,7 @@ The :mod:`real_flags` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.real_flags .. automodule:: nova.tests.real_flags
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -182,6 +199,7 @@ The :mod:`rpc_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.rpc_unittest .. automodule:: nova.tests.rpc_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -191,6 +209,7 @@ The :mod:`runtime_flags` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.runtime_flags .. automodule:: nova.tests.runtime_flags
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -200,6 +219,7 @@ The :mod:`twistd_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.twistd_unittest .. automodule:: nova.tests.twistd_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -209,6 +229,7 @@ The :mod:`validator_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.validator_unittest .. automodule:: nova.tests.validator_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

13
doc/source/devref/objectstore.rst
View File

@ -19,36 +19,40 @@ Objectstore - File Storage Service
================================== ==================================
The :mod:`nova.objectstore.handler` Module The :mod:`nova.objectstore.handler` Module
------------------------- ------------------------------------------
.. automodule:: nova.objectstore.handler .. automodule:: nova.objectstore.handler
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.objectstore.bucket` Module The :mod:`nova.objectstore.bucket` Module
------------------------ -----------------------------------------
.. automodule:: nova.objectstore.bucket .. automodule:: nova.objectstore.bucket
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.objectstore.stored` Module The :mod:`nova.objectstore.stored` Module
------------------------ -----------------------------------------
.. automodule:: nova.objectstore.stored .. automodule:: nova.objectstore.stored
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.objecstore.image` Module The :mod:`nova.objecstore.image` Module
----------------------- ----------------------------------------
.. automodule:: nova.objectstore.image .. automodule:: nova.objectstore.image
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -61,6 +65,7 @@ The :mod:`objectstore_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.objectstore_unittest .. automodule:: nova.tests.objectstore_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

13
doc/source/devref/scheduler.rst
View File

@ -19,36 +19,40 @@ Scheduler
========= =========
The :mod:`nova.scheduler.manager` Module The :mod:`nova.scheduler.manager` Module
------------------------- ----------------------------------------
.. automodule:: nova.scheduler.manager .. automodule:: nova.scheduler.manager
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.scheduler.driver` Module The :mod:`nova.scheduler.driver` Module
------------------------ ---------------------------------------
.. automodule:: nova.scheduler.driver .. automodule:: nova.scheduler.driver
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.scheduler.chance` Driver The :mod:`nova.scheduler.chance` Driver
------------------------ ---------------------------------------
.. automodule:: nova.scheduler.chance .. automodule:: nova.scheduler.chance
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.scheduler.simple` Driver The :mod:`nova.scheduler.simple` Driver
------------------------ ---------------------------------------
.. automodule:: nova.scheduler.simple .. automodule:: nova.scheduler.simple
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -61,6 +65,7 @@ The :mod:`scheduler_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.scheduler_unittest .. automodule:: nova.tests.scheduler_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

3
doc/source/devref/volume.rst
View File

@ -25,6 +25,7 @@ The :mod:`nova.volume.manager` Module
------------------------------------- -------------------------------------
.. automodule:: nova.volume.manager .. automodule:: nova.volume.manager
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -33,6 +34,7 @@ The :mod:`nova.volume.driver` Module
------------------------------------- -------------------------------------
.. automodule:: nova.volume.driver .. automodule:: nova.volume.driver
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -45,6 +47,7 @@ The :mod:`volume_unittest` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.tests.volume_unittest .. automodule:: nova.tests.volume_unittest
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance: