action_ansible docs build init

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-docs and the contents of the requirements.txt file in dest-dir.
fail-on-error	false	Corresponds to the --fail-on-error flag in antsibull-docs. Fails if plugins cannot be parsed. Has no effect if skip-init is true.
lenient	false	Corresponds to the --lenient flag for antsibull-docs 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-docs-version		The version of antsibull-docs to install. When set, it refers to a git ref from which to install. If not set, the latest version from PyPI is installed.
antsibull-docs-repository	ansible-community/antsibull-docs	When antsibull-docs-version is specified, this is the GitHub repository to which antsibull-docs-version refers. Has no effect if antsibull-docs-version is not supplied.
provide-link-targets		A newline separated list of link targets that should not cause reference errors. A small RST file will be created during the build which contains these labels.
intersphinx-links		A newline separated list of entries to add to the intersphinx_mapping in the generated conf.py. Use the syntax identifier:https://server/path to add the identifier identifier with URL https://server/path.
squash-hierarchy	false	If 'true', the collection documentation will be created at top-level and not in a subdirectory namespace/collection_name/. This is only possible if 'collections' contains exactly one collection.
index-rst-source		Copy the provided file to rst/index.rst intead of templating a default one.
project		Sets the project value in the Sphinx configuration.
copyright		Sets the copyright value in the Sphinx configuration.
title		Sets the title and html_short_title values in the Sphinx configuration. If html-short-title is also specified, only title will be set to the value specified here.
html-short-title		Sets the html_short_title value in the Sphinx configuration. If not specified, the value of title will be used.
extra-conf		A newline separated list of key=value entries that will be added to the generated conf.py.
extra-html-context		A newline separated list of key=value entries that will be added to the generated conf.py in html_context
extra-html-theme-options		A newline separated list of key=value entries that will be added to the generated conf.py in html_theme_options
append-conf-py		If provided, this text will be appended to the generated conf.py as-is.

---

Outputs

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