Merge "Adopting the common role documentation pattern"

README.rst

@@ -1,9 +1,28 @@
-OpenStack pip install
-#####################
-:tags: openstack, pip, install, cloud, ansible
-:category: \*nix
+OpenStack-Ansible pip install
+#############################
 
-This role will install pip using the upstream pip.
+This role will install pip using the upstream pip installation script. Within
+the installation of pip the role will create a .pip directory within the
+deploying user's home folder and a blank selfcheck JSON file for pip to use to
+keep track of versions.
+
+It can also configure pip links that will restrict the package sources to
+the OpenStack-Ansible repository.
+
+Default Variables
+=================
+
+.. literalinclude:: ../../defaults/main.yml
+   :language: yaml
+   :start-after: under the License.
+
+Required Variables
+==================
+
+None
+
+Example Playbook
+================
 
 .. code-block:: yaml
 
@@ -12,6 +31,4 @@ This role will install pip using the upstream pip.
       user: root
       roles:
         - role: "pip_install"
-          pip_upstream_url: https://bootstrap.pypa.io/get-pip.py
-          tags:
-            - "pip-install"
+          pip_lock_to_internal_repo: True

doc/source/index.rst

@@ -1,15 +1 @@
-pip_install role docs
-=====================
-
-This role will install pip using the upstream pip. Within the installation
-of pip the role will create a .pip directory within the deploying users
-home folder and and blank selfcheck JSON file for pip to use to keep track
-of versions.
-
-
-Basic Role Example
-^^^^^^^^^^^^^^^^^^
-
-.. code-block:: yaml
-
-    - role: "pip_install"
+.. include:: ../../README.rst