Simplify documentation
Change-Id: Iaeea7a0073c35c48e11d73976df850099e8c9cee Signed-off-by: Paul Belanger <pabelanger@redhat.com>
This commit is contained in:
parent
18b8f87a6e
commit
bc6fcdc900
37
README.rst
37
README.rst
|
@ -1,5 +1,16 @@
|
||||||
nodepool
|
=====================
|
||||||
========
|
ansible-role-nodepool
|
||||||
|
=====================
|
||||||
|
|
||||||
|
Ansible role to manage Nodepool
|
||||||
|
|
||||||
|
* License: Apache License, Version 2.0
|
||||||
|
* Documentation: https://ansible-role-nodepool.readthedocs.org
|
||||||
|
* Source: https://git.openstack.org/cgit/openstack/ansible-role-nodepool
|
||||||
|
* Bugs: https://bugs.launchpad.net/ansible-role-nodepool
|
||||||
|
|
||||||
|
Description
|
||||||
|
-----------
|
||||||
|
|
||||||
Nodepool is a system for launching single-use test nodes on demand based on
|
Nodepool is a system for launching single-use test nodes on demand based on
|
||||||
images built with cached data. It is designed to work with any OpenStack based
|
images built with cached data. It is designed to work with any OpenStack based
|
||||||
|
@ -18,21 +29,9 @@ Dependencies
|
||||||
Example Playbook
|
Example Playbook
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
License
|
.. code-block:: yaml
|
||||||
-------
|
|
||||||
Copyright 2015 Red Hat, Inc.
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
- name: Install nodepool
|
||||||
you may not use this file except in compliance with the License.
|
hosts: nodepool
|
||||||
You may obtain a copy of the License at
|
roles:
|
||||||
|
- ansible-role-nodepool
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
||||||
|
|
||||||
Author Information
|
|
||||||
------------------
|
|
||||||
|
|
|
@ -1,24 +1 @@
|
||||||
.. ansible-role-nodepool documentation master file, created by
|
.. include:: ../../README.rst
|
||||||
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
Welcome to ansible-role-nodepool's documentation!
|
|
||||||
=================================================
|
|
||||||
|
|
||||||
Contents:
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
readme
|
|
||||||
installation
|
|
||||||
usage
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
|
||||||
|
|
||||||
|
|
|
@ -1,12 +0,0 @@
|
||||||
============
|
|
||||||
Installation
|
|
||||||
============
|
|
||||||
|
|
||||||
At the command line::
|
|
||||||
|
|
||||||
$ pip install ansible-role-nodepool
|
|
||||||
|
|
||||||
Or, if you have virtualenvwrapper installed::
|
|
||||||
|
|
||||||
$ mkvirtualenv ansible-role-nodepool
|
|
||||||
$ pip install ansible-role-nodepool
|
|
|
@ -1 +0,0 @@
|
||||||
.. include:: ../../README.rst
|
|
|
@ -1,7 +0,0 @@
|
||||||
========
|
|
||||||
Usage
|
|
||||||
========
|
|
||||||
|
|
||||||
To use ansible-role-nodepool in a project::
|
|
||||||
|
|
||||||
import ansible-role-nodepool
|
|
Loading…
Reference in New Issue