Skip to content

Commit

Permalink
Added Sorin's changes to this PR
Browse files Browse the repository at this point in the history
  • Loading branch information
audgirka committed Mar 28, 2024
1 parent 5100a5e commit 9db1228
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 16 deletions.
24 changes: 9 additions & 15 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,22 @@ Requirements
- The ``--container-runtime`` option must correspond to the containerization tool you use.
- ``ansible-builder`` version ``3.x`` requires Python ``3.9`` or higher.

.. 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.

.. 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
$ pip3 install ansible-builder
.. note::

An **alternative** approach to install ``ansible-builder`` is using the ``ansible-dev-tools`` package.
`Ansible Development Tools (ADT) <https://ansible.readthedocs.io/projects/dev-tools/>`_ is a single Python package that includes all necessary tools to
set up a development environment, generate new collections, build and test the content consistently, resulting in robust automation.

.. code-block:: shell
# This also installs ansible-core if it is not already installed
$ pip3 install ansible-dev-tools
Install from Source
*******************
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
envlist = linters, unit
envlist = linters, unit, docs
isolated_build = True

[shared]
Expand Down

0 comments on commit 9db1228

Please sign in to comment.