rougail/docs/output/ansible.rst

Generate Ansible inventory
==========================

.. note::

    | **Path**: ansible
    | `*disabled*`
    | **Disabled**: when the variable "select for output" (step.output) is accessible and hasn't the value "ansible".



.. list-table::

   * - Variable
     - Description

   * - **ansible.output**

       `choice <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`

       **Command line**: 

       --ansible.output

       **Environment variable**: ROUGAILCLI_ANSIBLE.OUTPUT
     - Output type.

       **Choices**: 

       

       - inventory **← (default)**

       - doc

   * - **ansible.host_namespace**

       `string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`

       **Command line**: 

       --ansible.host_namespace

       **Environment variable**: ROUGAILCLI_ANSIBLE.HOST_NAMESPACE
     - Namespace with host values.

       **Default**: hosts

Doc configuration
-----------------

.. note::

    | **Path**: ansible.doc
    | `*disabled*`
    | **Disabled**: when the variable "Output type" (ansible.output) hasn't the value "doc".



.. list-table::

   * - Variable
     - Description

   * - **ansible.doc.project_name**

       `string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`

       **Command line**: 

       --ansible.doc.project_name

       **Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PROJECT_NAME
     - Ansible project name.

   * - **ansible.doc.author**

       `string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`

       **Command line**: 

       --ansible.doc.author

       **Environment variable**: ROUGAILCLI_ANSIBLE.DOC.AUTHOR
     - Ansible author name.

   * - **ansible.doc.output_format**

       `choice <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`

       **Command line**: 

       --ansible.doc.output_format

       **Environment variable**: ROUGAILCLI_ANSIBLE.DOC.OUTPUT_FORMAT
     - The output format of the generated documentation.

       **Choices**: 

       

       - console **← (default)**

       - asciidoc

       - html

       - github

       - gitlab

       - restructuredtext

       - json

   * - **ansible.doc.collection_type**

       `choice <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`

       **Command line**: 

       --ansible.doc.collection_type

       **Environment variable**: ROUGAILCLI_ANSIBLE.DOC.COLLECTION_TYPE
     - Collection contents.

       **Choices**: 

       

       - auto **← (default)**

       - playbooks

       - roles

Playbooks informations
~~~~~~~~~~~~~~~~~~~~~~

.. note::

    | This family contains lists of variable blocks.
    | **Path**: ansible.doc.playbooks
    | `*disabled*`
    | **Disabled**: if the content is a role.



.. list-table::

   * - Variable
     - Description

   * - **ansible.doc.playbooks.name**

       `string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `multiple` `unique`

       **Command line**: 

       --ansible.doc.playbooks.name

       **Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.NAME
     - Playbook name.

       Playbooks are placed in the playbooks/ directory. By default, the description of the "type" is used as the playbook name in the generated example. It is possible to customize this description here.

   * - **ansible.doc.playbooks.description**

       `string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`

       **Command line**: 

       --ansible.doc.playbooks.description

       **Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.DESCRIPTION
     - Playbook description.

Inventory configuration
-----------------------

.. note::

    | **Path**: ansible.inventory
    | `*disabled*`
    | **Disabled**: when the variable "Output type" (ansible.output) hasn't the value "inventory".



.. list-table::

   * - Variable
     - Description

   * - **ansible.inventory.no_namespace_in_vars**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`

       **Command line**: 

       

       - --ansible.inventory.no_namespace_in_vars

       - --ansible.inventory.no-no_namespace_in_vars

       

       **Environment variable**: ROUGAILCLI_ANSIBLE.INVENTORY.NO_NAMESPACE_IN_VARS
     - Remove namespace name in host vars.

       **Default**: false

   * - **ansible.inventory.export_warnings**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `mandatory`

       **Command line**: 

       

       - --ansible.inventory.export_warnings

       - --ansible.inventory.no-export_warnings

       

       **Environment variable**: ROUGAILCLI_ANSIBLE.INVENTORY.EXPORT_WARNINGS
     - Displays warnings inside Ansible exportation datas.

       **Default**: true