File tree 26 files changed +247
-40
lines changed
baseline-default/collections
baseline-no-breadcrumbs/collections
baseline-no-indexes/collections
baseline-squash-hierarchy
baseline-use-html-blobs/collections
26 files changed +247
-40
lines changed Original file line number Diff line number Diff line change
1
+
2
+ :orphan:
3
+
4
+ .. _list_of_collection_env_vars :
5
+
6
+ Index of all Collection Environment Variables
7
+ =============================================
8
+
9
+ The following index documents all environment variables declared by plugins and modules in collections.
10
+ Environment variables used by the ansible-core configuation are documented in :ref: `ansible_configuration_settings `.
11
+
12
+ .. envvar :: ANSIBLE_FOO_EXE
13
+
14
+ Foo executable.
15
+
16
+ *Used by: *
17
+ :ref: `ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become >`
18
+ .. envvar :: ANSIBLE_FOO_FILENAME_EXT
19
+
20
+ All extensions to check.
21
+
22
+ *Used by: *
23
+ :ref: `ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars >`
24
+ .. envvar :: ANSIBLE_FOO_USER
25
+
26
+ User you 'become' to execute the task.
27
+
28
+ *Used by: *
29
+ :ref: `ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become >`
30
+ .. envvar :: ANSIBLE_REMOTE_TEMP
31
+
32
+ Temporary directory to use on targets when executing tasks.
33
+
34
+ *Used by: *
35
+ :ref: `ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell >`
36
+ .. envvar :: ANSIBLE_REMOTE_TMP
37
+
38
+ Temporary directory to use on targets when executing tasks.
39
+
40
+ *Used by: *
41
+ :ref: `ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell >`
Original file line number Diff line number Diff line change @@ -211,9 +211,9 @@ Parameters
211
211
Alternative: nothing
212
212
213
213
214
- - Environment variable: ANSIBLE\_ BECOME\_ EXE
214
+ - Environment variable: :envvar: ` ANSIBLE\_ BECOME\_ EXE `
215
215
216
- - Environment variable: ANSIBLE\_ FOO\_ EXE
216
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ EXE `
217
217
218
218
Removed in: version 3.0.0
219
219
@@ -297,11 +297,11 @@ Parameters
297
297
user = root
298
298
299
299
300
- - Environment variable: ANSIBLE\_ BECOME\_ USER
300
+ - Environment variable: :envvar: ` ANSIBLE\_ BECOME\_ USER `
301
301
302
302
:ansible-option-versionadded: `added in ns2.col 0.1.0 `
303
303
304
- - Environment variable: ANSIBLE\_ FOO\_ USER
304
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ USER `
305
305
306
306
- Variable: ansible\_ become\_ user
307
307
Original file line number Diff line number Diff line change @@ -141,7 +141,7 @@ Parameters
141
141
fact_caching_connection = VALUE
142
142
143
143
144
- - Environment variable: ANSIBLE\_ CACHE\_ PLUGIN\_ CONNECTION
144
+ - Environment variable: :envvar: ` ANSIBLE\_ CACHE\_ PLUGIN\_ CONNECTION `
145
145
146
146
147
147
.. raw :: html
Original file line number Diff line number Diff line change @@ -148,9 +148,9 @@ Parameters
148
148
remote_tmp = ~/.ansible/tmp
149
149
150
150
151
- - Environment variable: ANSIBLE\_ REMOTE\_ TEMP
151
+ - Environment variable: :envvar: ` ANSIBLE\_ REMOTE\_ TEMP `
152
152
153
- - Environment variable: ANSIBLE\_ REMOTE\_ TMP
153
+ - Environment variable: :envvar: ` ANSIBLE\_ REMOTE\_ TMP `
154
154
155
155
- Variable: ansible\_ remote\_ tmp
156
156
Original file line number Diff line number Diff line change @@ -156,7 +156,7 @@ Parameters
156
156
foo_valid_extensions = .foo, .foobar
157
157
158
158
159
- - Environment variable: ANSIBLE\_ FOO\_ FILENAME\_ EXT
159
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ FILENAME\_ EXT `
160
160
161
161
162
162
.. raw :: html
Original file line number Diff line number Diff line change
1
+
2
+ :orphan:
3
+
4
+ .. _list_of_collection_env_vars :
5
+
6
+ Index of all Collection Environment Variables
7
+ =============================================
8
+
9
+ The following index documents all environment variables declared by plugins and modules in collections.
10
+ Environment variables used by the ansible-core configuation are documented in :ref: `ansible_configuration_settings `.
11
+
12
+ .. envvar :: ANSIBLE_FOO_EXE
13
+
14
+ Foo executable.
15
+
16
+ *Used by: *
17
+ :ref: `ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become >`
18
+ .. envvar :: ANSIBLE_FOO_FILENAME_EXT
19
+
20
+ All extensions to check.
21
+
22
+ *Used by: *
23
+ :ref: `ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars >`
24
+ .. envvar :: ANSIBLE_FOO_USER
25
+
26
+ User you 'become' to execute the task.
27
+
28
+ *Used by: *
29
+ :ref: `ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become >`
30
+ .. envvar :: ANSIBLE_REMOTE_TEMP
31
+
32
+ Temporary directory to use on targets when executing tasks.
33
+
34
+ *Used by: *
35
+ :ref: `ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell >`
36
+ .. envvar :: ANSIBLE_REMOTE_TMP
37
+
38
+ Temporary directory to use on targets when executing tasks.
39
+
40
+ *Used by: *
41
+ :ref: `ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell >`
Original file line number Diff line number Diff line change @@ -211,9 +211,9 @@ Parameters
211
211
Alternative: nothing
212
212
213
213
214
- - Environment variable: ANSIBLE\_ BECOME\_ EXE
214
+ - Environment variable: :envvar: ` ANSIBLE\_ BECOME\_ EXE `
215
215
216
- - Environment variable: ANSIBLE\_ FOO\_ EXE
216
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ EXE `
217
217
218
218
Removed in: version 3.0.0
219
219
@@ -297,11 +297,11 @@ Parameters
297
297
user = root
298
298
299
299
300
- - Environment variable: ANSIBLE\_ BECOME\_ USER
300
+ - Environment variable: :envvar: ` ANSIBLE\_ BECOME\_ USER `
301
301
302
302
:ansible-option-versionadded: `added in ns2.col 0.1.0 `
303
303
304
- - Environment variable: ANSIBLE\_ FOO\_ USER
304
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ USER `
305
305
306
306
- Variable: ansible\_ become\_ user
307
307
Original file line number Diff line number Diff line change @@ -141,7 +141,7 @@ Parameters
141
141
fact_caching_connection = VALUE
142
142
143
143
144
- - Environment variable: ANSIBLE\_ CACHE\_ PLUGIN\_ CONNECTION
144
+ - Environment variable: :envvar: ` ANSIBLE\_ CACHE\_ PLUGIN\_ CONNECTION `
145
145
146
146
147
147
.. raw :: html
Original file line number Diff line number Diff line change @@ -148,9 +148,9 @@ Parameters
148
148
remote_tmp = ~/.ansible/tmp
149
149
150
150
151
- - Environment variable: ANSIBLE\_ REMOTE\_ TEMP
151
+ - Environment variable: :envvar: ` ANSIBLE\_ REMOTE\_ TEMP `
152
152
153
- - Environment variable: ANSIBLE\_ REMOTE\_ TMP
153
+ - Environment variable: :envvar: ` ANSIBLE\_ REMOTE\_ TMP `
154
154
155
155
- Variable: ansible\_ remote\_ tmp
156
156
Original file line number Diff line number Diff line change @@ -156,7 +156,7 @@ Parameters
156
156
foo_valid_extensions = .foo, .foobar
157
157
158
158
159
- - Environment variable: ANSIBLE\_ FOO\_ FILENAME\_ EXT
159
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ FILENAME\_ EXT `
160
160
161
161
162
162
.. raw :: html
Original file line number Diff line number Diff line change
1
+
2
+ :orphan:
3
+
4
+ .. _list_of_collection_env_vars :
5
+
6
+ Index of all Collection Environment Variables
7
+ =============================================
8
+
9
+ The following index documents all environment variables declared by plugins and modules in collections.
10
+ Environment variables used by the ansible-core configuation are documented in :ref: `ansible_configuration_settings `.
11
+
12
+ .. envvar :: ANSIBLE_FOO_EXE
13
+
14
+ Foo executable.
15
+
16
+ *Used by: *
17
+ :ref: `ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become >`
18
+ .. envvar :: ANSIBLE_FOO_FILENAME_EXT
19
+
20
+ All extensions to check.
21
+
22
+ *Used by: *
23
+ :ref: `ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars >`
24
+ .. envvar :: ANSIBLE_FOO_USER
25
+
26
+ User you 'become' to execute the task.
27
+
28
+ *Used by: *
29
+ :ref: `ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become >`
30
+ .. envvar :: ANSIBLE_REMOTE_TEMP
31
+
32
+ Temporary directory to use on targets when executing tasks.
33
+
34
+ *Used by: *
35
+ :ref: `ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell >`
36
+ .. envvar :: ANSIBLE_REMOTE_TMP
37
+
38
+ Temporary directory to use on targets when executing tasks.
39
+
40
+ *Used by: *
41
+ :ref: `ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell >`
Original file line number Diff line number Diff line change @@ -211,9 +211,9 @@ Parameters
211
211
Alternative: nothing
212
212
213
213
214
- - Environment variable: ANSIBLE\_ BECOME\_ EXE
214
+ - Environment variable: :envvar: ` ANSIBLE\_ BECOME\_ EXE `
215
215
216
- - Environment variable: ANSIBLE\_ FOO\_ EXE
216
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ EXE `
217
217
218
218
Removed in: version 3.0.0
219
219
@@ -297,11 +297,11 @@ Parameters
297
297
user = root
298
298
299
299
300
- - Environment variable: ANSIBLE\_ BECOME\_ USER
300
+ - Environment variable: :envvar: ` ANSIBLE\_ BECOME\_ USER `
301
301
302
302
:ansible-option-versionadded: `added in ns2.col 0.1.0 `
303
303
304
- - Environment variable: ANSIBLE\_ FOO\_ USER
304
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ USER `
305
305
306
306
- Variable: ansible\_ become\_ user
307
307
Original file line number Diff line number Diff line change @@ -141,7 +141,7 @@ Parameters
141
141
fact_caching_connection = VALUE
142
142
143
143
144
- - Environment variable: ANSIBLE\_ CACHE\_ PLUGIN\_ CONNECTION
144
+ - Environment variable: :envvar: ` ANSIBLE\_ CACHE\_ PLUGIN\_ CONNECTION `
145
145
146
146
147
147
.. raw :: html
Original file line number Diff line number Diff line change @@ -148,9 +148,9 @@ Parameters
148
148
remote_tmp = ~/.ansible/tmp
149
149
150
150
151
- - Environment variable: ANSIBLE\_ REMOTE\_ TEMP
151
+ - Environment variable: :envvar: ` ANSIBLE\_ REMOTE\_ TEMP `
152
152
153
- - Environment variable: ANSIBLE\_ REMOTE\_ TMP
153
+ - Environment variable: :envvar: ` ANSIBLE\_ REMOTE\_ TMP `
154
154
155
155
- Variable: ansible\_ remote\_ tmp
156
156
Original file line number Diff line number Diff line change @@ -156,7 +156,7 @@ Parameters
156
156
foo_valid_extensions = .foo, .foobar
157
157
158
158
159
- - Environment variable: ANSIBLE\_ FOO\_ FILENAME\_ EXT
159
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ FILENAME\_ EXT `
160
160
161
161
162
162
.. raw :: html
Original file line number Diff line number Diff line change
1
+
2
+ :orphan:
3
+
4
+ .. _list_of_collection_env_vars :
5
+
6
+ Index of all Collection Environment Variables
7
+ =============================================
8
+
9
+ The following index documents all environment variables declared by plugins and modules in collections.
10
+ Environment variables used by the ansible-core configuation are documented in :ref: `ansible_configuration_settings `.
11
+
12
+ .. envvar :: ANSIBLE_FOO_EXE
13
+
14
+ Foo executable.
15
+
16
+ *Used by: *
17
+ :ref: `ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become >`
18
+ .. envvar :: ANSIBLE_FOO_FILENAME_EXT
19
+
20
+ All extensions to check.
21
+
22
+ *Used by: *
23
+ :ref: `ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars >`
24
+ .. envvar :: ANSIBLE_FOO_USER
25
+
26
+ User you 'become' to execute the task.
27
+
28
+ *Used by: *
29
+ :ref: `ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become >`
30
+ .. envvar :: ANSIBLE_REMOTE_TEMP
31
+
32
+ Temporary directory to use on targets when executing tasks.
33
+
34
+ *Used by: *
35
+ :ref: `ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell >`
36
+ .. envvar :: ANSIBLE_REMOTE_TMP
37
+
38
+ Temporary directory to use on targets when executing tasks.
39
+
40
+ *Used by: *
41
+ :ref: `ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell >`
Original file line number Diff line number Diff line change @@ -211,9 +211,9 @@ Parameters
211
211
Alternative: nothing
212
212
213
213
214
- - Environment variable: ANSIBLE\_ BECOME\_ EXE
214
+ - Environment variable: :envvar: ` ANSIBLE\_ BECOME\_ EXE `
215
215
216
- - Environment variable: ANSIBLE\_ FOO\_ EXE
216
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ EXE `
217
217
218
218
Removed in: version 3.0.0
219
219
@@ -297,11 +297,11 @@ Parameters
297
297
user = root
298
298
299
299
300
- - Environment variable: ANSIBLE\_ BECOME\_ USER
300
+ - Environment variable: :envvar: ` ANSIBLE\_ BECOME\_ USER `
301
301
302
302
:ansible-option-versionadded: `added in ns2.col 0.1.0 `
303
303
304
- - Environment variable: ANSIBLE\_ FOO\_ USER
304
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ USER `
305
305
306
306
- Variable: ansible\_ become\_ user
307
307
Original file line number Diff line number Diff line change @@ -141,7 +141,7 @@ Parameters
141
141
fact_caching_connection = VALUE
142
142
143
143
144
- - Environment variable: ANSIBLE\_ CACHE\_ PLUGIN\_ CONNECTION
144
+ - Environment variable: :envvar: ` ANSIBLE\_ CACHE\_ PLUGIN\_ CONNECTION `
145
145
146
146
147
147
.. raw :: html
Original file line number Diff line number Diff line change @@ -148,9 +148,9 @@ Parameters
148
148
remote_tmp = ~/.ansible/tmp
149
149
150
150
151
- - Environment variable: ANSIBLE\_ REMOTE\_ TEMP
151
+ - Environment variable: :envvar: ` ANSIBLE\_ REMOTE\_ TEMP `
152
152
153
- - Environment variable: ANSIBLE\_ REMOTE\_ TMP
153
+ - Environment variable: :envvar: ` ANSIBLE\_ REMOTE\_ TMP `
154
154
155
155
- Variable: ansible\_ remote\_ tmp
156
156
Original file line number Diff line number Diff line change @@ -156,7 +156,7 @@ Parameters
156
156
foo_valid_extensions = .foo, .foobar
157
157
158
158
159
- - Environment variable: ANSIBLE\_ FOO\_ FILENAME\_ EXT
159
+ - Environment variable: :envvar: ` ANSIBLE\_ FOO\_ FILENAME\_ EXT `
160
160
161
161
162
162
.. raw :: html
You can’t perform that action at this time.
0 commit comments