Skip to content

Enabling mkdocs-ansible macros

In order to activate the macros inside your documentation project you need to add:

# mkdocs.yml
plugins:
  - macros:
      modules: [mkdocs-ansible:mkdocs_ansible]

Using install_from_adt macro

Inside markdown documentation include a section like below, the expanded result can be seen after the example.

{{ install_from_adt("ansible-navigator") }}

Recommendation

The recommended approach to install ansible-navigator is using the ansible-dev-tools package. Ansible Development Tools aims to streamline the setup and usage of several tools needed in order to create Ansible content. It combines critical Ansible development packages into a unified Python package.

# This also installs ansible-core if it is not already installed
pip3 install ansible-dev-tools