-
Notifications
You must be signed in to change notification settings - Fork 7
action_ansible docs build init
briantist[bot] edited this page Feb 6, 2022
·
11 revisions
Sets up various requirements and preparation for building Ansible docs. Requires Python.
| 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. |
fail-on-error |
false |
Corresponds to the --fail-on-error flag in antsibull. Fails if plugins cannot be parsed. Has no effect if skip-init is true. |
lenient |
false |
Corresponds to the --lenient flag for antsibull sphinx-init. By default, the build process will fail on warnings unless this is set to 'true'. Has no effect if skip-init is true. |
antsibull-version |
The version of antsibull to install. When set, it refers to a git ref from which to install. If not set, the latest version from PyPI is installed. |
| Name | Description |
|---|---|
build-script |
The path of the build script to execute. |
build-html |
The path of the build's html output directory. |