Skip to content

Commit

Permalink
Add recommendation as a note
Browse files Browse the repository at this point in the history
  • Loading branch information
audgirka committed Mar 26, 2024
1 parent 22132ae commit 75a30a0
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,26 @@ Requirements
- The ``--container-runtime`` option must correspond to the containerization tool you use.
- ``ansible-builder`` version ``3.x`` requires Python ``3.9`` or higher.

Recommended Installation Method
********************************
.. note::

The **recommended** approach to install `ansible-builder` is using the
`ansible-dev-tools` package.
`Ansible Development Tools (ADT) https://ansible.readthedocs.io/projects/dev-tools/`
aims to streamline the setup and usage of several tools needed in order to
create `Ansible https://www.ansible.com` content. ADT combines critical Ansible
development packages into a unified Python package.
The **recommended** approach to install ``ansible-builder`` is using the
``ansible-dev-tools`` package.
`Ansible Development Tools (ADT) <https://ansible.readthedocs.io/projects/dev-tools/>`_
aims to streamline the setup and usage of several tools needed in order to
create `Ansible <https://www.ansible.com>`_ content. ADT combines critical Ansible
development packages into a unified Python package.

.. code-block:: shell
# This also installs ansible-core if it is not already installed
$ pip3 install ansible-dev-tools
.. code-block:: shell
# This also installs ansible-core if it is not already installed
$ pip3 install ansible-dev-tools
Install from PyPi
*****************

.. code-block:: shell
$ pip install ansible-builder
$ pip3 install ansible-builder
Install from Source
Expand All @@ -44,10 +42,10 @@ To install from the mainline development branch:

.. code-block:: shell
$ pip install https://github.com/ansible/ansible-builder/archive/devel.zip
$ pip3 install https://github.com/ansible/ansible-builder/archive/devel.zip
To install from a specific tag or branch, replace :code:`<ref>` in the following example:

.. code-block:: shell
$ pip install https://github.com/ansible/ansible-builder/archive/<ref>.zip
$ pip3 install https://github.com/ansible/ansible-builder/archive/<ref>.zip

0 comments on commit 75a30a0

Please sign in to comment.