Improve patrole core documentation
Updates patrole's current documentation with improved formatting.
Also updates many sections to add more clarity and detail.
Change-Id: Idebe341e2fcb0ee04db979d41df9bef5395af1b5
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 76064f1..b532d63 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -3,24 +3,24 @@
============
Installation Information
-########################
+========================
At the command line::
- $ pip install patrole
+ $ sudo pip install patrole
Or, if you have virtualenvwrapper installed::
$ mkvirtualenv patrole
- $ pip install patrole
+ $ sudo pip install patrole
Or to install from the source::
$ navigate to patrole directory
- $ pip install -e .
+ $ sudo pip install -e .
Configuration Information
-#########################
+=========================
tempest.conf
++++++++++++
@@ -28,25 +28,25 @@
To run the RBAC tempest api test, you have to make the following changes to
the tempest.conf file.
-#. [auth] section updates ::
+#. ``auth`` section updates ::
- # Allows test cases to create/destroy projects and users. This option
- # requires that OpenStack Identity API admin credentials are known. If
- # false, isolated test cases and parallel execution, can still be
- # achieved configuring a list of test accounts (boolean value)
- use_dynamic_credentials = True
+ # Allows test cases to create/destroy projects and users. This option
+ # requires that OpenStack Identity API admin credentials are known. If
+ # false, isolated test cases and parallel execution, can still be
+ # achieved configuring a list of test accounts (boolean value)
+ use_dynamic_credentials = True
-#. [rbac] section updates ::
+#. ``rbac`` section updates ::
- # The role that you want the RBAC tests to use for RBAC testing
- # This needs to be edited to run the test as a different role.
- rbac_test_role = _member_
+ # The role that you want the RBAC tests to use for RBAC testing
+ # This needs to be edited to run the test as a different role.
+ rbac_test_role = _member_
- # Enables RBAC Tempest tests if set to True. Otherwise, they are
- # skipped.
- enable_rbac = True
+ # Enables RBAC Tempest tests if set to True. Otherwise, they are
+ # skipped.
+ enable_rbac = True
- # If set to true, tests throw a RbacParsingException for policies
- # not found in the policy.json. Otherwise, they throw a
- # skipException.
- strict_policy_check = False
+ # If set to true, tests throw a RbacParsingException for policies
+ # not found in the policy.json. Otherwise, they throw a
+ # skipException.
+ strict_policy_check = False