mirror of
https://github.com/thegeeklab/ansible-doctor.git
synced 2024-11-21 20:30:43 +00:00
docs: add documentation for new option role_detection
This commit is contained in:
parent
4b28c6339f
commit
febe038766
@ -8,9 +8,7 @@ You can get all available CLI options by running `ansible-doctor --help`:
|
||||
<!-- spellchecker-disable -->
|
||||
{{< highlight Shell "linenos=table" >}}
|
||||
$ ansible-doctor --help
|
||||
usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-v]
|
||||
[-q] [--version]
|
||||
role_dir
|
||||
usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-n] [-v] [-q] [--version] [role_dir]
|
||||
|
||||
Generate documentation from annotated Ansible roles using templates
|
||||
|
||||
@ -25,6 +23,8 @@ optional arguments:
|
||||
output base dir
|
||||
-f, --force force overwrite output file
|
||||
-d, --dry-run dry run without writing
|
||||
-n, --no-role-detection
|
||||
disable automatic role detection
|
||||
-v increase log level
|
||||
-q decrease log level
|
||||
--version show program's version number and exit
|
||||
|
@ -11,6 +11,9 @@ title: Default settings
|
||||
role_dir:
|
||||
# default is the basename of '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
|
||||
dry_run: False
|
||||
|
||||
|
@ -6,6 +6,7 @@ title: Environment Variables
|
||||
<!-- spellchecker-disable -->
|
||||
{{< highlight Shell "linenos=table" >}}
|
||||
ANSIBLE_DOCTOR_CONFIG_FILE=
|
||||
ANSIBLE_DOCTOR_ROLE_DETECTION=true
|
||||
ANSIBLE_DOCTOR_ROLE_DIR=
|
||||
ANSIBLE_DOCTOR_ROLE_NAME=
|
||||
ANSIBLE_DOCTOR_DRY_RUN=false
|
||||
|
Loading…
Reference in New Issue
Block a user