diff --git a/doc/source/admin/manage-volumes.rst b/doc/source/admin/manage-volumes.rst index 8f187be5ad..194b1e7768 100644 --- a/doc/source/admin/manage-volumes.rst +++ b/doc/source/admin/manage-volumes.rst @@ -114,12 +114,12 @@ volumes. `*` Source `NIST SP 800-38E `_ - .. note:: +.. note:: - To see further information and CLI instructions, see - `Create an encrypted volume type - `__ - in the OpenStack Configuration Reference. + To see further information and CLI instructions, see + `Create an encrypted volume type + `__ + in the OpenStack Configuration Reference. Delete volume types ~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/configuration/customizing.rst b/doc/source/configuration/customizing.rst index bff71f3866..ff0bb413e0 100644 --- a/doc/source/configuration/customizing.rst +++ b/doc/source/configuration/customizing.rst @@ -302,7 +302,9 @@ instructions on how to use icons in the code. To add icon to Table Action, use icon property. Example: - class CreateSnapshot(tables.LinkAction): +.. code-block:: python + + class CreateSnapshot(tables.LinkAction): name = "snapshot" verbose_name = _("Create Snapshot") icon = "camera" diff --git a/doc/source/contributor/faq.rst b/doc/source/contributor/faq.rst index c1c7ab3154..2e1d4c7516 100644 --- a/doc/source/contributor/faq.rst +++ b/doc/source/contributor/faq.rst @@ -5,7 +5,6 @@ Frequently Asked Questions ========================== What is the relationship between ``Dashboards``, ``Panels``, and navigation? - The navigational structure is strongly encouraged to flow from ``Dashboard`` objects as top-level navigation items to ``Panel`` objects as sub-navigation items as in the current implementation. Template tags @@ -15,7 +14,6 @@ What is the relationship between ``Dashboards``, ``Panels``, and navigation? templates and URLconfs by hand to create any desired structure. Does a panel have to be an app in ``INSTALLED_APPS``? - A panel can live in any Python module. It can be a standalone which ties into an existing dashboard, or it can be contained alongside others within a larger dashboard "app". There is no strict enforcement here. Python @@ -24,14 +22,12 @@ Does a panel have to be an app in ``INSTALLED_APPS``? convenient way to load a standalone panel. Could I hook an external service into a panel using, for example, an iFrame? - Panels are just entry-points to hook views into the larger dashboard navigational structure and enforce common attributes like RBAC. The views and corresponding templates can contain anything you would like, including iFrames. What does this mean for visual design? - The ability to add an arbitrary number of top-level navigational items (``Dashboard`` objects) poses a new design challenge. Horizon's lead designer has taken on the challenge of providing a reference design diff --git a/doc/source/contributor/topics/packaging.rst b/doc/source/contributor/topics/packaging.rst index a2865ffa7b..0e350d27c4 100644 --- a/doc/source/contributor/topics/packaging.rst +++ b/doc/source/contributor/topics/packaging.rst @@ -215,4 +215,4 @@ This is the `recommended way`_ for Django applications. Depending on configuration, it might be required to ``manage.py compress`` during package build, too. - .. _`recommended way`: https://docs.djangoproject.com/en/dev/howto/static-files/deployment/ +.. _`recommended way`: https://docs.djangoproject.com/en/dev/howto/static-files/deployment/ diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index a86b22ded3..5a7b26c3a4 100644 --- a/doc/source/glossary.rst +++ b/doc/source/glossary.rst @@ -5,22 +5,18 @@ Glossary ======== Horizon - The OpenStack dashboard project. Also the name of the top-level Python object which handles registration for the app. Dashboard - A Python class representing a top-level navigation item (e.g. "project") which provides a consistent API for Horizon-compatible applications. Panel - A Python class representing a sub-navigation item (e.g. "instances") which contains all the necessary logic (views, forms, tests, etc.) for that interface. Project - Used in user-facing text in place of the term "Tenant" which is Keystone's word. diff --git a/horizon/tables/actions.py b/horizon/tables/actions.py index d47463057b..cf6d3eca33 100644 --- a/horizon/tables/actions.py +++ b/horizon/tables/actions.py @@ -228,8 +228,10 @@ class Action(BaseAction): list of scope and rule tuples to do policy checks on, the composition of which is (scope, rule) - scope: service type managing the policy for action - rule: string representing the action to be checked + * scope: service type managing the policy for action + * rule: string representing the action to be checked + + .. code-block:: python for a policy that requires a single rule check: policy_rules should look like diff --git a/openstack_auth/utils.py b/openstack_auth/utils.py index ce9998498a..91ac31cb9f 100644 --- a/openstack_auth/utils.py +++ b/openstack_auth/utils.py @@ -210,14 +210,14 @@ def get_websso_url(request, auth_url, websso_auth): The value in WEBSSO_IDP_MAPPING is expected to be a tuple formatted as (, ). Using the values found, a IdP/protocol - specific URL will be constructed: + specific URL will be constructed:: /auth/OS-FEDERATION/identity_providers/ /protocols//websso If no value is found from the WEBSSO_IDP_MAPPING dictionary, it will treat the value as the global WebSSO protocol and - construct the WebSSO URL by: + construct the WebSSO URL by:: /auth/OS-FEDERATION/websso/