Skip to content

Commit

Permalink
Suggest adt installation (#662)
Browse files Browse the repository at this point in the history
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Matt Martz <matt@sivel.net>
  • Loading branch information
3 people authored Apr 22, 2024
1 parent 167ed5c commit f940906
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
14 changes: 11 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,16 @@ Install from PyPI

.. code-block:: shell
$ pip install ansible-builder
$ pip3 install ansible-builder
.. note::

An **alternative** approach to installing ``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.

.. code-block:: shell
# This also installs ansible-core if it is not already installed
$ pip3 install ansible-dev-tools
Install from Source
*******************
Expand All @@ -28,10 +36,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
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 f940906

Please sign in to comment.