Skip to content

action_ansible docs build init

BS[bot] edited this page Jan 16, 2022 · 11 revisions

ansible-docs-build-init

Initialize the environment for building Ansible docs

Sets up various requirements and preparation for building Ansible docs. Requires Python.

Inputs

Name (✅required) Default Description
dest-dir ${{ runner.temp }}/docsbuild The destination directory for preparing the build environment. Note that this must be within the Workspace for hashes to be calculated.
collections Limit the docs build to one or more collections, in the form namespace.collection.
Multiple collections should be separated by spaces.
If this isn't limited, then all collections in the collections path will be included in the built docs.
skip-init false If 'true', dest-dir will be assumed to already be initialized, so this action will only install
antsibull and the contents of the requirements.txt file in dest-dir.

Outputs

Name Description
build-script The path of the build script to execute.
build-html The path of the build's html output directory.
Clone this wiki locally