# Antsibull-docs does not include roles in collection documentation

**URL:** <https://forum.ansible.com/t/antsibull-docs-does-not-include-roles-in-collection-documentation/3916>\
**Category:** Get Help\
**Tags:** ansible-navigator, antsibull\
**Created:** [February 16, 2024, 10:47pm UTC](https://forum.ansible.com/t/antsibull-docs-does-not-include-roles-in-collection-documentation/3916 "2024-02-16T22:47:51Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![mpmackenna](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mpmackenna/32/2341_2.png) [@mpmackenna](https://forum.ansible.com/u/mpmackenna)\
**Post date:** [February 16, 2024, 10:47pm UTC](https://forum.ansible.com/t/antsibull-docs-does-not-include-roles-in-collection-documentation/3916/1 "2024-02-16T22:47:52Z")

</div>

I am generating documentation for a collection. I used antsibull-docs to generate it. My modules get documented without issue, but my roles did not. I included the necessary argument\_spec.yml file as indicated by the documentation but that did not seem to make a difference. I noticed the example site for sensu.sensu\_go has a roles index. I also see documentation for a number of my roles when I browse the collection in ansible-navigator. I am not sure what I am missing. Any help is greatly appreciated!

This is the guide I followed.

[Documenting collections — Ansible Documentation](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_documenting.html)

This site has a role index.

[https://docs.ansible.com/ansible/latest/collections/sensu/sensu\_go/index.html#role-index](https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/index.html#role-index)

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [February 16, 2024, 11:06pm UTC](https://forum.ansible.com/t/antsibull-docs-does-not-include-roles-in-collection-documentation/3916/2 "2024-02-16T23:06:10Z")

</div>

Did you name the file `argument_spec.yml` (as indicated in your post) or `argument_specs.yml` (as in the documentation you reference)? The plural `s` before the extension is important.

Also you should try looking at the role’s documentation with ansible-doc: `ansible-doc --type role foo.bar.baz`. If that works, then generating the docs with antsibull-docs should also work. (Assuming you are not using a very old version of ansible-core that doesn’t support role documentation - but then `ansible-doc --type role` won’t work either.)

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [February 16, 2024, 11:07pm UTC](https://forum.ansible.com/t/antsibull-docs-does-not-include-roles-in-collection-documentation/3916/3 "2024-02-16T23:07:19Z")

</div>

(Here’s an example from my own collection: [ansible-acme/roles/acme\_certificate/meta/argument\_specs.yml at main · felixfontein/ansible-acme · GitHub](https://github.com/felixfontein/ansible-acme/blob/main/roles/acme_certificate/meta/argument_specs.yml) - and here’s one from sensu.sensu\_go: [sensu-go-ansible/roles/agent/meta/argument\_specs.yml at master · sensu/sensu-go-ansible · GitHub](https://github.com/sensu/sensu-go-ansible/blob/master/roles/agent/meta/argument_specs.yml))

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/ansible/original/1X/1882d9a01da5d8996a862359b0913cc568a39b84.svg) [@system](https://forum.ansible.com/u/system)\
**Post date:** [April 9, 2024, 4:21pm UTC](https://forum.ansible.com/t/antsibull-docs-does-not-include-roles-in-collection-documentation/3916/4 "2024-04-09T16:21:02Z")

</div>

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.