cleanup rrd doc generation.

This commit is contained in:
Todd Willey
2010-10-27 17:31:46 -04:00
parent 9491a67484
commit f473f8a45b
5 changed files with 51 additions and 43 deletions

View File

@@ -195,18 +195,34 @@ The :mod:`signer` Module
:undoc-members:
:show-inheritance:
The :mod:`users` Module
-----------------------
The :mod:`manager` Module
-------------------------
.. automodule:: nova.auth.users
.. automodule:: nova.auth.manager
:members:
:undoc-members:
:show-inheritance:
The :mod:`users_unittest` Module
The :mod:`ldapdriver` Module
----------------------------
.. automodule:: nova.auth.ldapdriver
:members:
:undoc-members:
:show-inheritance:
The :mod:`dbdriver` Module
----------------------------
.. automodule:: nova.auth.dbdriver
:members:
:undoc-members:
:show-inheritance:
The :mod:`auth_unittest` Module
--------------------------------
.. automodule:: nova.tests.users_unittest
.. automodule:: nova.tests.auth_unittest
:members:
:undoc-members:
:show-inheritance:

View File

@@ -15,33 +15,35 @@
License for the specific language governing permissions and limitations
under the License.
Compute Documentation
=====================
from etherpad todo
------------------
::
* FIX RST IMPORT ERRORS
* Compute Manager
* public methods
* responsibilities
* Compute Driver
* public methods
* libvirt implementation
- kvm/qemu
- uml
* libvirt implementation (kvm/qemu vs uml)
* xen implementation
* hyperv implementation
legacy docs
-----------
Compute Documentation
=====================
This page contains the Compute Package documentation.
The :mod:`manager` Module
-------------------------
.. automodule:: nova.compute.manager
:members:
:undoc-members:
:show-inheritance:
The :mod:`disk` Module
----------------------
@@ -50,45 +52,37 @@ The :mod:`disk` Module
:undoc-members:
:show-inheritance:
The :mod:`exception` Module
---------------------------
The :mod:`instance_types` Module
--------------------------------
.. automodule:: nova.compute.exception
.. automodule:: nova.compute.instance_types
:members:
:undoc-members:
:show-inheritance:
The :mod:`model` Module
The :mod:`power_state` Module
-----------------------------
.. automodule:: nova.compute.power_state
:members:
:undoc-members:
:show-inheritance:
The :mod:`monitor` Module
-------------------------
.. automodule:: nova.compute.model
:members:
:undoc-members:
:show-inheritance:
The :mod:`network` Module
-------------------------
.. automodule:: nova.compute.network
.. automodule:: nova.compute.monitor
:members:
:undoc-members:
:show-inheritance:
The :mod:`node` Module
----------------------
.. automodule:: nova.compute.node
:members:
:undoc-members:
:show-inheritance:
RELATED TESTS
---------------
-------------
The :mod:`node_unittest` Module
-------------------------------
The :mod:`compute_unittest` Module
----------------------------------
.. automodule:: nova.tests.node_unittest
.. automodule:: nova.tests.compute_unittest
:members:
:undoc-members:
:show-inheritance:

View File

@@ -16,7 +16,7 @@ import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.append([os.path.abspath('../nova'), os.path.abspath('..'), os.path.abspath('../bin')])
sys.path.insert(0, '../..')
# -- General configuration -----------------------------------------------------

View File

@@ -79,7 +79,6 @@ def _match_query(query, attrs):
&, |, and ! are supported in the query. No syntax checking is performed,
so malformed querys will not work correctly.
"""
# cut off the parentheses
inner = query[1:-1]

View File

@@ -84,12 +84,11 @@ class AuthBase(object):
@classmethod
def safe_id(cls, obj):
"""Safe get object id
"""Safely get object id.
This method will return the id of the object if the object
is of this class, otherwise it will return the original object.
This allows methods to accept objects or ids as paramaters.
"""
if isinstance(obj, cls):
return obj.id