Improve handling of environment variables #166
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #164.
This PR:
envvar_directives
to the per-collection configuration. This allows the collection to declare which environment variables its extra docsite docs declare with a.. envvar::
directive (example: https://github.com/ansible-collections/community.docker/pull/645/files#diff-2e6bfe479f7c2ad97ebb36910a39078e428365e0d6b29e7308ee3f255eda06e9 and https://github.com/ansible-collections/community.docker/pull/645/files#diff-51b1f7ed0708ccb6cda1e16d8b545eff7458d232c13fc144c47a64e9b404c39d).:ansenvvar:
(environment variable without reference) and:ansenvvarref:
(environment variable with a reference; also is clever enough to only use the part before=
to reference a.. envvar::
directive).envvar_directives
config for one collection in the docsite; b) it is mentioned in the ansible-core config; c) it is mentioned in a plugin config in one of the collections used in the docsite.Example: https://ansible.fontein.de/collections/community/docker/docker_container_module.html#notes - the environment variables mentioned in there are clickable and lead you to their definitions in https://ansible.fontein.de/collections/community/docker/docsite/scenario_guide.html#environment-variables