Browse Source

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
tags/2014.1.b2
Facundo Maldonado 5 years ago
parent
commit
1880fd63aa

+ 1
- 0
doc/source/topics/tables.rst View File

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

+ 1
- 0
horizon/base.py View File

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

+ 23
- 20
openstack_dashboard/api/network_base.py View File

@@ -129,26 +129,29 @@ class SecurityGroupManager(object):
129 129
 
130 130
     SecurityGroup object returned from methods in this class
131 131
     must contains the following attributes:
132
-    - id : ID of Security Group (int for Nova, uuid for Neutron)
133
-    - name
134
-    - description
135
-    - tenant_id
136
-    - rules : A list of SecurityGroupRule objects
137
-
138
-    SecurityGroupRule object should have the following attributes:
139
-    The attribute names and their formats are borrowed from nova
140
-    security group implementation.
141
-    - id
142
-    - direction
143
-    - ethertype
144
-    - parent_group_id : security group the rule belongs to
145
-    - ip_protocol
146
-    - from_port : lower limit of allowed port range (inclusive)
147
-    - to_port : upper limit of allowed port range (inclusive)
148
-    - ip_range : remote IP CIDR (source for ingress, dest for egress)
149
-          The value should be a format of "{'cidr': <cidr>}"
150
-    - group : remote security group
151
-          The value should be a format of "{'name': <secgroup_name>}"
132
+
133
+    * id: ID of Security Group (int for Nova, uuid for Neutron)
134
+    * name
135
+    * description
136
+    * tenant_id
137
+    * rules: A list of SecurityGroupRule objects
138
+
139
+    SecurityGroupRule object should have the following attributes
140
+    (The attribute names and their formats are borrowed from nova
141
+    security group implementation):
142
+
143
+    * id
144
+    * direction
145
+    * ethertype
146
+    * parent_group_id: security group the rule belongs to
147
+    * ip_protocol
148
+    * from_port: lower limit of allowed port range (inclusive)
149
+    * to_port: upper limit of allowed port range (inclusive)
150
+    * ip_range: remote IP CIDR (source for ingress, dest for egress).
151
+    The value should be a format of "{'cidr': <cidr>}"
152
+    * group: remote security group. The value should be a format of
153
+    "{'name': <secgroup_name>}"
154
+
152 155
     """
153 156
 
154 157
     __metaclass__ = abc.ABCMeta

+ 3
- 3
openstack_dashboard/dashboards/project/images_and_snapshots/utils.py View File

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

+ 19
- 13
openstack_dashboard/policy.py View File

@@ -65,22 +65,28 @@ def check(actions, request, target={}):
65 65
     Check if the user has permission to the action according
66 66
     to policy setting.
67 67
 
68
-    :param actions: list of scope and action to do policy checks on, the
69
-                    composition of which is (scope, action)
68
+    :param actions: list of scope and action to do policy checks on,
69
+        the composition of which is (scope, action)
70 70
 
71
-        scope: service type managing the policy for action
72
-        action: string representing the action to be checked
71
+        * scope: service type managing the policy for action
72
+
73
+        * action: string representing the action to be checked
73 74
 
74 75
             this should be colon separated for clarity.
75
-            i.e. compute:create_instance
76
-                 compute:attach_volume
77
-                 volume:attach_volume
78
-
79
-       for a policy action that requires a single action:
80
-           actions should look like "(("compute", "compute:create_instance"),)"
81
-       for a multiple action check:
82
-           actions should look like "(("identity", "identity:list_users"),
83
-                                      ("identity", "identity:list_roles"))"
76
+            i.e.
77
+
78
+                | compute:create_instance
79
+                | compute:attach_volume
80
+                | volume:attach_volume
81
+
82
+        for a policy action that requires a single action, actions
83
+        should look like
84
+
85
+            | "(("compute", "compute:create_instance"),)"
86
+
87
+        for a multiple action check, actions should look like
88
+            | "(("identity", "identity:list_users"),
89
+            |   ("identity", "identity:list_roles"))"
84 90
 
85 91
     :param request: django http request object. If not specified, credentials
86 92
                     must be passed.

+ 5
- 5
openstack_dashboard/utils/settings.py View File

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

Loading…
Cancel
Save