workflow_shared docs build push

_shared-docs-build-push.yml

Ansible collection docs build (Push)

Jobs

ID	Name	Permissions
build-ansible-docs	Build Ansible Docs	contents: read

---

Inputs

Name (✅required)	Type	Default	Description
collection-name	string	${{ github.event.repository.name }}	The collection name in the form namespace.collection.
collection-path	string		This is the relative path component of the collection in question, for example community/general.
python	string	3.13	The version of Python to install.
ansible-ref	string	stable-2.18	The ref from which to install ansible, for example "stable-2.14" or "milestone".
build-ref	string		The ref from this repository to check out and build. The default is the default of the actions/checkout action.
init-dest-dir	string		A directory relative to the checkout where the init process has already been run.
init-lenient	boolean	False	Use the lenient option during build init. Has no effect if init-dest-dir is supplied.
init-fail-on-error	boolean	False	Use the fail-on-error option during build init. Has no effect if init-dest-dir is supplied.
init-antsibull-docs-version	string		The version of antsibull-docs to use during build init. Has no effect if init-dest-dir is supplied. If not supplied, the latest version from PyPI is used. If supplied, must be a git ref from the antsibull-docs repository.
init-antsibull-docs-repository	string	ansible-community/antsibull-docs	When init-antsibull-docs-version is specified, this is the GitHub repository to which init-antsibull-docs-version refers. Has no effect if init-dest-dir is supplied, or if init-antsibull-docs-version is not supplied.
init-index-rst-source	string		Copy the provided file to rst/index.rst intead of templating a default one.
init-project	string		Sets the project value in the Sphinx configuration.
init-copyright	string		Sets the copyright value in the Sphinx configuration.
init-title	string		Sets the title and html_short_title values in the Sphinx configuration. If init-html-short-title is also specified, only title will be set to the value specified here.
init-html-short-title	string		Sets the html_short_title value in the Sphinx configuration. If not specified, the value of init-title will be used.
init-extra-conf	string		A newline separated list of key=value entries that will be added to the generated conf.py.
init-extra-html-context	string		A newline separated list of key=value entries that will be added to the generated conf.py in html_context
init-extra-html-theme-options	string		A newline separated list of key=value entries that will be added to the generated conf.py in html_theme_options
init-append-conf-py	string		If provided, this text will be appended to the generated conf.py as-is.
artifact-upload	boolean	True	Whether or not to upload the build as an artifact.
artifact-name	string	${{ github.event.repository.name }}docs${{ github.sha }}	The name of the artifact to upload.
extra-collections	string		A space separated list of additional collections to install prior to building the documentation.
provide-link-targets	string		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	string		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	boolean	False	If 'true', the collection documentation will be created at top-level and not in a subdirectory namespace/collection_name/. Has no effect if init-dest-dir is supplied.

---

Secrets

Name (✅required)	Description

---

Outputs

Name	Description
artifact-name	The same artifact name as passed in, available as an output.
artifact-url	The URL to the build artifacts.