Allow to pass --squash-hierarchy to 'antsibull-docs sphinx-init' #58
Conversation
This reverts commit 54713f1.
| squash-hierarchy: | ||
| description: | | ||
| 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. |
There was a problem hiding this comment.
What happens if the flag is used with more than one collection?
There was a problem hiding this comment.
spinx-init will complain :) You can see it here: https://github.com/ansible-community/github-docs-build/actions/runs/3536149650/jobs/5934924344 - there was a bug in the tests that collections wasn't actually passed on, and thus squash-hierarchy was used with zero collections in that case.
|
@briantist thanks for reviewing! |
|
Unfortunately this introduced bugs into the shared workflows, see #59 for a fix. |
|
#60 had another one. But now it works, see https://ansible-collections.github.io/community.dns/branch/main/ for the result. |
|
Ok, and after yet another fix the PR workflow also works, see https://github.com/ansible-collections/community.dns/actions/runs/3535870339 - ansible-collections/community.dns#123 (comment) - https://ansible-collections.github.io/community.dns/pr/123/ |
2 participants
That would allow to have the collections docs to be at https://ansible-collections.github.io/community.dns/branch/main/ instead of having them in a subdirectory https://ansible-collections.github.io/community.dns/branch/main/collections/community/dns/.