How to define docsite for antsibull-docs/sphinx

On this page:

https://ansible.readthedocs.io/projects/antsibull-docs/collection-docs/

Instructions exist that often refer to docsite but never define which of the directories is the docsite. Is it the built-docs directory or the built-docs/rst directory, or some other directory, perhaps built-docs/build?

I believe it refers to ansible-documentation/docs/docsite at devel · ansible/ansible-documentation · GitHub

Most of the instances of the use “docsite” on that page refer to the general concept of a docsite. That word is similarly used than “website” or “homepage”. Ansible Documentation — Ansible Community Documentation is a docsite, https://ansible.fontein.de/ is a docsite, …

When talking about a directory, it’s usually the docs/docsite/ directory inside a collection. But then it usually explicitly says docs/docsite/.

But does it have to be a folder under docs, can it be the docs folder itself? It’s not super clear what folder structure, if any, is required.

What is “it” in your question? The extra docs material must be in docs/docsite/ (like config.yml, extra-docs.yml, links.yml, and rst/ for extra documentation source files). Where you place the rendered result or the build scripts for the docsite is up to you. It can be whereever you want in the filesystem.

1 Like