Polish the docs up some more. Also make 'index.html' forward to the actual html output

This commit is contained in:
Tim Bielawa 2012-03-07 12:41:53 -05:00
commit baf2a05708
40 changed files with 257 additions and 6302 deletions

View file

@ -50,22 +50,57 @@ Requirements are extremely minimal.
If you are running python 2.6 on the **overlord** machine, you will
need:
* paramiko
* python-jinja2
* PyYAML (if using playbooks)
* ``paramiko``
* ``PyYAML``
* ``Asciidoc`` (for building documentation)
If you are running less than Python 2.6, you will also need
If you are running less than Python 2.6, you will also need:
* the Python 2.4 or 2.5 backport of the multiprocessing module
* simplejson
* The Python 2.4 or 2.5 backport of the multiprocessing module
* `Installation and Testing Instructions <http://code.google.com/p/python-multiprocessing/wiki/Install>`_
* ``simplejson``
On the managed nodes, to use templating, you will need:
* python-jinja2 (you can install this with ansible)
* ``python-jinja2`` (you can install this with ansible)
Getting Ansible
```````````````
Contents:
Tagged releases are available as tar.gz files from the Ansible github
project page:
* `Ansible/downloads <https://github.com/ansible/ansible/downloads>`_
You can also clone the git repository yourself and install Ansible in
one of two ways:
Python Distutils
++++++++++++++++
You can install Ansible using Python Distutils::
$ git clone git://github.com/ansible/ansible.git
$ cd ./ansible
$ sudo make install
Via RPM
+++++++
In the future, pre-built RPMs may be available. Until that time you
can use the ``make rpm`` command::
$ git clone git://github.com/ansible/ansible.git
$ cd ./ansible
$ make rpm
$ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-1.0-1.noarch.rpm
Contents
========
.. toctree::
:maxdepth: 3
@ -75,15 +110,17 @@ Contents:
patterns
modules
playbooks
examples
api
communicate
examples
man
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Communicate or Get Involved
===========================
* Join the `ansible-project mailing list <http://groups.google.com/group/ansible-project>`_ on Google Groups
* Join `#ansible <irc://irc.freenode.net/#ansible>`_ on the `freenode IRC network <http://freenode.net/>`_
* Visit the `project page <https://github.com/ansible/ansible>`_ on Github
- View the `issue tracker <https://github.com/ansible/ansible/issues>`_

View file

@ -5,12 +5,17 @@ Man Pages
Ansile ships with a handfull of manpages to help you on your journey.
taboot(1)
---------
ansible(1)
----------
`View taboot.1 <man/taboot.1.html>`_
* `View ansible.1 <man/ansible.1.html>`_
taboot-tasks(5)
---------------
ansible-modules(5)
------------------
`View taboot-tasks.5 <man/taboot-tasks.5.html>`_
* `View ansible-modules.5 <man/ansible-modules.5.html>`_
ansible-playbook(5)
-------------------
* `View ansible-playbook.5 <man/ansible-playbook.5.html>`_