docs: add documentation for new option role_detection

This commit is contained in:
Robert Kaussow 2021-07-27 22:09:13 +02:00
parent 4b28c6339f
commit febe038766
Signed by: xoxys
GPG Key ID: 4E692A2EAECC03C0
3 changed files with 7 additions and 3 deletions

View File

@ -8,9 +8,7 @@ You can get all available CLI options by running `ansible-doctor --help`:
<!-- spellchecker-disable --> <!-- spellchecker-disable -->
{{< highlight Shell "linenos=table" >}} {{< highlight Shell "linenos=table" >}}
$ ansible-doctor --help $ ansible-doctor --help
usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-v] usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-n] [-v] [-q] [--version] [role_dir]
[-q] [--version]
role_dir
Generate documentation from annotated Ansible roles using templates Generate documentation from annotated Ansible roles using templates
@ -25,6 +23,8 @@ optional arguments:
output base dir output base dir
-f, --force force overwrite output file -f, --force force overwrite output file
-d, --dry-run dry run without writing -d, --dry-run dry run without writing
-n, --no-role-detection
disable automatic role detection
-v increase log level -v increase log level
-q decrease log level -q decrease log level
--version show program's version number and exit --version show program's version number and exit

View File

@ -11,6 +11,9 @@ title: Default settings
role_dir: role_dir:
# default is the basename of 'role_name' # default is the basename of 'role_name'
role_name: role_name:
# Auto-detect if the given directory is a role, can be disabled
# to parse loose files instead.
role_detection: True
# don't write anything to file system # don't write anything to file system
dry_run: False dry_run: False

View File

@ -6,6 +6,7 @@ title: Environment Variables
<!-- spellchecker-disable --> <!-- spellchecker-disable -->
{{< highlight Shell "linenos=table" >}} {{< highlight Shell "linenos=table" >}}
ANSIBLE_DOCTOR_CONFIG_FILE= ANSIBLE_DOCTOR_CONFIG_FILE=
ANSIBLE_DOCTOR_ROLE_DETECTION=true
ANSIBLE_DOCTOR_ROLE_DIR= ANSIBLE_DOCTOR_ROLE_DIR=
ANSIBLE_DOCTOR_ROLE_NAME= ANSIBLE_DOCTOR_ROLE_NAME=
ANSIBLE_DOCTOR_DRY_RUN=false ANSIBLE_DOCTOR_DRY_RUN=false