Skip to content

The official Ansible docsite

antsibull-docs is used in the build pipeline of the official Ansible docsites at docs.ansible.com/projects/ansible/devel and docs.ansible.com/projects/ansible/latest to generate the documentation for all collections included in Ansible. It is also used for the ansible-core documentation to generate the documentation for ansible.builtin, the collection included with ansible-core.

The RST sources for all other files of the Ansible docsite can be found in the ansible/ansible-documentation GitHub repository. This repository also contains the docsite build scripts. antsibull-docs is called from hacking/build_library/build_ansible/command_plugins/docs_build.py. This uses the devel and stable subcommands of antsibull-docs. For its input, data from the ansible-community/ansible-build-data GitHub repository is used. For building stable docs for a major Ansible version $X, the latest ansible-$X.$Y.$Z.deps file in the $X/ directory in ansible-build-data is used. For building the devel docs, the list of collections is used from the latest $Y/ansible.in file in ansible-build-data with the largest $Y that can be found in the repository. Then the latest version of every collection listed in $Y/ansible.in is used.

For the exact build process, please refer to the build process in the ansible-documentation repository.