Fixed sphinx ERRORs.

Fixed errors and warnings due to formatting and layout errors
in documentation.
Those errors makes the page be empty or unavailable.
Other layouts/format fixes makes documentation more clear.

Removed rpc/common.py from patch as suggested in code review.

Change-Id: I0fe11f66384f1aa8919bbb3f5cdf5339f0cbdfc6
Partial-Bug:1257725
This commit is contained in:
Facundo Maldonado 2013-12-16 14:16:44 -03:00
parent 9942527626
commit 1880fd63aa
6 changed files with 50 additions and 39 deletions

View File

@ -257,6 +257,7 @@ parse the data. The updating process is fully encapsulated into table
functionality, communication with the server goes through AJAX in JSON format.
The javacript wrapper for inline editing allows each table cell that has
in-line editing available to:
#. Refresh itself with new data from the server.
#. Display in edit mod.
#. Send changed data to server.

View File

@ -371,6 +371,7 @@ class Dashboard(Registry, HorizonComponent):
Boolean value to determine whether this dashboard can be viewed
without being logged in. Defaults to ``False``.
"""
_registerable_class = Panel
name = ''

View File

@ -129,26 +129,29 @@ class SecurityGroupManager(object):
SecurityGroup object returned from methods in this class
must contains the following attributes:
- id : ID of Security Group (int for Nova, uuid for Neutron)
- name
- description
- tenant_id
- rules : A list of SecurityGroupRule objects
SecurityGroupRule object should have the following attributes:
The attribute names and their formats are borrowed from nova
security group implementation.
- id
- direction
- ethertype
- parent_group_id : security group the rule belongs to
- ip_protocol
- from_port : lower limit of allowed port range (inclusive)
- to_port : upper limit of allowed port range (inclusive)
- ip_range : remote IP CIDR (source for ingress, dest for egress)
The value should be a format of "{'cidr': <cidr>}"
- group : remote security group
The value should be a format of "{'name': <secgroup_name>}"
* id: ID of Security Group (int for Nova, uuid for Neutron)
* name
* description
* tenant_id
* rules: A list of SecurityGroupRule objects
SecurityGroupRule object should have the following attributes
(The attribute names and their formats are borrowed from nova
security group implementation):
* id
* direction
* ethertype
* parent_group_id: security group the rule belongs to
* ip_protocol
* from_port: lower limit of allowed port range (inclusive)
* to_port: upper limit of allowed port range (inclusive)
* ip_range: remote IP CIDR (source for ingress, dest for egress).
The value should be a format of "{'cidr': <cidr>}"
* group: remote security group. The value should be a format of
"{'name': <secgroup_name>}"
"""
__metaclass__ = abc.ABCMeta

View File

@ -22,9 +22,9 @@ def get_available_images(request, project_id=None, images_cache=None):
project_id. If project_id is not specified, only public images
are returned.
:param images_cache:
An optional dict-like object in which to
cache public and per-project id image metadata.
:param images_cache: An optional dict-like object in which to
cache public and per-project id image metadata.
"""
if images_cache is None:
images_cache = {}

View File

@ -65,22 +65,28 @@ def check(actions, request, target={}):
Check if the user has permission to the action according
to policy setting.
:param actions: list of scope and action to do policy checks on, the
composition of which is (scope, action)
:param actions: list of scope and action to do policy checks on,
the composition of which is (scope, action)
scope: service type managing the policy for action
action: string representing the action to be checked
* scope: service type managing the policy for action
* action: string representing the action to be checked
this should be colon separated for clarity.
i.e. compute:create_instance
compute:attach_volume
volume:attach_volume
i.e.
for a policy action that requires a single action:
actions should look like "(("compute", "compute:create_instance"),)"
for a multiple action check:
actions should look like "(("identity", "identity:list_users"),
("identity", "identity:list_roles"))"
| compute:create_instance
| compute:attach_volume
| volume:attach_volume
for a policy action that requires a single action, actions
should look like
| "(("compute", "compute:create_instance"),)"
for a multiple action check, actions should look like
| "(("identity", "identity:list_users"),
| ("identity", "identity:list_roles"))"
:param request: django http request object. If not specified, credentials
must be passed.

View File

@ -63,12 +63,12 @@ def update_dashboards(modules, horizon_config, installed_apps):
For example, given this setup:
foo/__init__.py
foo/_10_baz.py
foo/_20_qux.py
| foo/__init__.py
| foo/_10_baz.py
| foo/_20_qux.py
bar/__init__.py
bar/_30_baz_.py
| bar/__init__.py
| bar/_30_baz_.py
and being called with ``modules=[foo, bar]``, we will first have the
configuration from ``_10_baz`` and ``_30_baz`` merged, then the