diff --git a/README.rst b/README.rst index e145c4d7..655c7235 100644 --- a/README.rst +++ b/README.rst @@ -4,22 +4,29 @@ Welcome to tower-cli ==================== -**tower-cli** is a command line tool for Ansible Tower. It allows Tower -commands to be easily run from the Unix command line. It can also be -used as a client library for other python apps, or as a reference for -others developing API interactions with Tower's REST API. - -For more information, please refer to our official docs hosted at http://tower-cli.readthedocs.io. - - .. |Build Status| image:: https://img.shields.io/travis/com/ansible/tower-cli.svg - :target: https://travis-ci.com/ansible/tower-cli - .. |Coverage Status| image:: https://img.shields.io/coveralls/ansible/tower-cli.svg - :target: https://coveralls.io/r/ansible/tower-cli - .. |Version| image:: https://img.shields.io/pypi/v/ansible-tower-cli.svg - :target: https://pypi.python.org/pypi/ansible-tower-cli/ - .. |Downloads| image:: https://img.shields.io/pypi/dm/ansible-tower-cli.svg - :target: https://pypi.python.org/pypi/ansible-tower-cli/ - .. |License| image:: https://img.shields.io/pypi/l/ansible-tower-cli.svg - :target: https://pypi.python.org/pypi/ansible-tower-cli/ - .. |Supported Python Versions| image:: https://img.shields.io/pypi/pyversions/ansible-tower-cli.svg +**tower-cli** is a legacy command line tool for Ansible Tower. + +It is also what the Ansible `tower_*` modules use under the hood. Such as: + +https://docs.ansible.com/ansible/latest/modules/tower_organization_module.html + +Supporting correct operation of the modules is the maintenance aim of this +package. + +Anyone developing new tooling around AWX or Ansible Tower via a Unix command +line is suggested to use the new CLI. + +https://github.com/ansible/awx/tree/devel/awxkit/awxkit/cli/docs + + .. |Build Status| image:: https://img.shields.io/travis/com/ansible/tower-cli.svg + :target: https://travis-ci.com/ansible/tower-cli + .. |Coverage Status| image:: https://img.shields.io/coveralls/ansible/tower-cli.svg + :target: https://coveralls.io/r/ansible/tower-cli + .. |Version| image:: https://img.shields.io/pypi/v/ansible-tower-cli.svg + :target: https://pypi.python.org/pypi/ansible-tower-cli/ + .. |Downloads| image:: https://img.shields.io/pypi/dm/ansible-tower-cli.svg + :target: https://pypi.python.org/pypi/ansible-tower-cli/ + .. |License| image:: https://img.shields.io/pypi/l/ansible-tower-cli.svg + :target: https://pypi.python.org/pypi/ansible-tower-cli/ + .. |Supported Python Versions| image:: https://img.shields.io/pypi/pyversions/ansible-tower-cli.svg :target: https://pypi.python.org/pypi/ansible-tower-cli/ diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html new file mode 100644 index 00000000..8b2284f2 --- /dev/null +++ b/docs/source/_templates/layout.html @@ -0,0 +1,5 @@ + + +{% extends '!layout.html' %} \ No newline at end of file