From febe03876675f0fc195588c065031f8250cb6928 Mon Sep 17 00:00:00 2001
From: Robert Kaussow <mail@thegeeklab.de>
Date: Tue, 27 Jul 2021 22:09:13 +0200
Subject: [PATCH] docs: add documentation for new option role_detection

---
 docs/content/configuration/cli.md      | 6 +++---
 docs/content/configuration/defaults.md | 3 +++
 docs/content/configuration/env.md      | 1 +
 3 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/docs/content/configuration/cli.md b/docs/content/configuration/cli.md
index 67c909f..48194ae 100644
--- a/docs/content/configuration/cli.md
+++ b/docs/content/configuration/cli.md
@@ -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
diff --git a/docs/content/configuration/defaults.md b/docs/content/configuration/defaults.md
index 2ced473..9418fe9 100644
--- a/docs/content/configuration/defaults.md
+++ b/docs/content/configuration/defaults.md
@@ -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
 
diff --git a/docs/content/configuration/env.md b/docs/content/configuration/env.md
index b57c981..398d18b 100644
--- a/docs/content/configuration/env.md
+++ b/docs/content/configuration/env.md
@@ -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