From a1554a47e388dcb6382e6329bea78981e01ffe29 Mon Sep 17 00:00:00 2001 From: Andrew Meserole Date: Thu, 11 Aug 2016 16:35:21 -0500 Subject: [PATCH] [DOCS] Refactor pip install Docs This commit refactors the pip_install role docs. Moving forward, specific project configurations are maintained in the appropriate role book. Change-Id: Ic62c7dd8b655a4ef6aa22ca02a599a07996a76f9 --- README.rst | 38 ++++++-------------------------------- doc/source/index.rst | 30 +++++++++++++++++++++++++++++- examples/playbook.yml | 6 ++++++ 3 files changed, 41 insertions(+), 33 deletions(-) create mode 100644 examples/playbook.yml diff --git a/README.rst b/README.rst index f345d48..bfc5aee 100644 --- a/README.rst +++ b/README.rst @@ -1,35 +1,9 @@ +============================= OpenStack-Ansible pip install -############################# +============================= -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 - - - name: Install pip and lock it down - hosts: host_name - user: root - roles: - - role: "pip_install" - pip_lock_to_internal_repo: True +Documentation for the project can be found at: + http://docs.openstack.org/developer/openstack-ansible-pip_install/ +The project home is at: + http://launchpad.net/openstack-ansible diff --git a/doc/source/index.rst b/doc/source/index.rst index a6210d3..ffae610 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1 +1,29 @@ -.. include:: ../../README.rst +============================= +OpenStack-Ansible pip install +============================= + +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 +~~~~~~~~~~~~~~~~ + +.. literalinclude:: ../../examples/playbook.yml + :language: yaml diff --git a/examples/playbook.yml b/examples/playbook.yml new file mode 100644 index 0000000..a3785e0 --- /dev/null +++ b/examples/playbook.yml @@ -0,0 +1,6 @@ +- name: Install pip and lock it down + hosts: host_name + user: root + roles: + - role: "pip_install" + pip_lock_to_internal_repo: True \ No newline at end of file