fix docs formatting

This commit is contained in:
Robert Kaussow 2020-06-03 16:22:56 +02:00
parent d5f038923b
commit a5b3eab603
10 changed files with 29 additions and 19 deletions

View File

@ -11,7 +11,6 @@ YAML
Yaml Yaml
ansible-.+ ansible-.+
basename basename
cli
config config
dir dir
SELinux SELinux

View File

@ -2,3 +2,5 @@
default: True default: True
MD013: False MD013: False
MD041: False MD041: False
MD004:
style: dash

View File

@ -2,12 +2,12 @@
title: Configuration title: Configuration
--- ---
*ansible-doctor* comes with default settings which should be sufficient for most users to start, but you can adjust most settings to your needs. _ansible-doctor_ comes with default settings which should be sufficient for most users to start, but you can adjust most settings to your needs.
Changes can be made on different locations which will be processed in the following order (last wins): Changes can be made on different locations which will be processed in the following order (last wins):
* default config (build-in) - default config (build-in)
* global config file (path depends on your operating system) - global config file (path depends on your operating system)
* folder-based config file (.ansibledoctor.yml|.ansibledoctor.yaml|.ansibledoctor in current working dir) - folder-based config file (.ansibledoctor.yml|.ansibledoctor.yaml|.ansibledoctor in current working dir)
* environment variables - environment variables
* cli options - CLI options

View File

@ -2,8 +2,9 @@
title: CLI options title: CLI options
--- ---
You can get all available cli options by running `ansible-doctor --help`: You can get all available CLI options by running `ansible-doctor --help`:
<!-- prettier-ignore-start -->
{{< 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] [-v]
@ -27,3 +28,4 @@ optional arguments:
-q decrease log level -q decrease log level
--version show program's version number and exit --version show program's version number and exit
{{< /highlight >}} {{< /highlight >}}
<!-- prettier-ignore-end -->

View File

@ -2,6 +2,7 @@
title: Default settings title: Default settings
--- ---
<!-- prettier-ignore-start -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
{{< highlight YAML "linenos=table" >}} {{< highlight YAML "linenos=table" >}}
--- ---
@ -38,3 +39,4 @@ exclude_files: []
# - files/**/*.py # - files/**/*.py
{{< /highlight >}} {{< /highlight >}}
<!-- markdownlint-restore --> <!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

View File

@ -2,6 +2,7 @@
title: Environment Variables title: Environment Variables
--- ---
<!-- prettier-ignore-start -->
{{< highlight Shell "linenos=table" >}} {{< highlight Shell "linenos=table" >}}
ANSIBLE_DOCTOR_CONFIG_FILE= ANSIBLE_DOCTOR_CONFIG_FILE=
ANSIBLE_DOCTOR_ROLE_DIR= ANSIBLE_DOCTOR_ROLE_DIR=
@ -17,3 +18,4 @@ ANSIBLE_DOCTOR_CUSTOM_HEADER=
ANSIBLE_DOCTOR_EXCLUDE_FILES= ANSIBLE_DOCTOR_EXCLUDE_FILES=
ANSIBLE_DOCTOR_EXCLUDE_FILES=molecule/,files/**/*.py ANSIBLE_DOCTOR_EXCLUDE_FILES=molecule/,files/**/*.py
{{< /highlight >}} {{< /highlight >}}
<!-- prettier-ignore-end -->

View File

@ -1,4 +1,3 @@
--- ---
title: Setup title: Setup
--- ---

View File

@ -1,8 +1,8 @@
--- ---
title: Using docker title: Using docker
--- ---
<!-- prettier-ignore-start -->
{{< highlight Shell "linenos=table" >}} {{< highlight Shell "linenos=table" >}}
docker run \ docker run \
-e ANSIBLE_DOCTOR_ROLE_DIR=example/demo-role/ \ -e ANSIBLE_DOCTOR_ROLE_DIR=example/demo-role/ \
@ -15,6 +15,7 @@ docker run \
-w /doctor \ -w /doctor \
xoxys/ansible-doctor xoxys/ansible-doctor
{{< /highlight >}} {{< /highlight >}}
<!-- prettier-ignore-end -->
{{< hint info >}} {{< hint info >}}
**Info**\ **Info**\

View File

@ -1,8 +1,8 @@
--- ---
title: Using pip title: Using pip
--- ---
<!-- prettier-ignore-start -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
{{< highlight Shell "linenos=table" >}} {{< highlight Shell "linenos=table" >}}
# From PyPI as unprivileged user # From PyPI as unprivileged user
@ -15,3 +15,4 @@ $ sudo pip install ansible-doctor
$ pip install https://github.com/xoxys/ansible-doctor/releases/download/v0.1.1/ansible_doctor-0.1.1-py2.py3-none-any.whl $ pip install https://github.com/xoxys/ansible-doctor/releases/download/v0.1.1/ansible_doctor-0.1.1-py2.py3-none-any.whl
{{< /highlight >}} {{< /highlight >}}
<!-- markdownlint-restore --> <!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

View File

@ -6,15 +6,16 @@ title: Usage
ansible-doctor FOLDER ansible-doctor FOLDER
``` ```
If you don't pass a folder to *ansible-doctor* your current working directory will be used. The first step is to identify if the given folder is an Ansible role. This check is very simple, if the folder contains a subfolder called `tasks` is MUST be an Ansible role! :) If you don't pass a folder to _ansible-doctor_ your current working directory will be used. The first step is to identify if the given folder is an Ansible role. This check is very simple, if the folder contains a subfolder called `tasks` is MUST be an Ansible role! :)
After the successful check, *ansible-doctor* will try to read some static files into a dictionary: After the successful check, _ansible-doctor_ will try to read some static files into a dictionary:
* defaults/main.yml - defaults/main.yml
* meta/main.yml - meta/main.yml
This will be the base result set which is used as data source for every output template. Without any work, you will get at least a documentation about available variables and some meta information. Theses basic information can be expanded with a set of available annotations. In general, an annotation is a comment with an identifier. This identifier is followed by colon separated options and ends with a value. This will be the base result set which is used as data source for every output template. Without any work, you will get at least a documentation about available variables and some meta information. Theses basic information can be expanded with a set of available annotations. In general, an annotation is a comment with an identifier. This identifier is followed by colon separated options and ends with a value.
<!-- prettier-ignore-start -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
{{< highlight Yaml "linenos=table" >}} {{< highlight Yaml "linenos=table" >}}
# @identifier option1:option2: <value> # @identifier option1:option2: <value>
@ -28,10 +29,11 @@ This will be the base result set which is used as data source for every output t
docker_registry_password: "secret" docker_registry_password: "secret"
{{< /highlight >}} {{< /highlight >}}
<!-- markdownlint-restore --> <!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
These list of predefined identifiers is currently available: These list of predefined identifiers is currently available:
* @meta - @meta
* @todo - @todo
* @var - @var
* @tag - @tag