# Can't display module documentation with ansible-doc

**URL:** <https://forum.ansible.com/t/cant-display-module-documentation-with-ansible-doc/2701>\
**Category:** Get Help\
**Tags:** documentation\
**Created:** [December 2, 2023, 4:15pm UTC](https://forum.ansible.com/t/cant-display-module-documentation-with-ansible-doc/2701 "2023-12-02T16:15:42Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![dulhaver](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/dulhaver/32/1061_2.png) [@dulhaver](https://forum.ansible.com/u/dulhaver)\
**Post date:** [December 2, 2023, 4:15pm UTC](https://forum.ansible.com/t/cant-display-module-documentation-with-ansible-doc/2701/1 "2023-12-02T16:15:42Z")

</div>

I fail to display the documentation for modules despite the fact the respective collection exists, is generally known to Ansible and the module has the (I believe) correct `DOCUMENTATION = """` section.

```auto
┌─[me][laptop][~] ansible-doc digital_ocean_firewall
[WARNING]: digital_ocean_firewall was not found

┌─[me][laptop][~] ansible-galaxy collection list community.digitalocean
# /usr/lib/python3.11/site-packages/ansible_collections
Collection Version
---------------------- -------
community.digitalocean 1.24.0 

┌─[me][laptop][~] ls -l /usr/lib/python3.11/site-packages/ansible_collections/community/digitalocean/plugins/modules/digital_ocean_firewall.py
-rw-r--r-- 1 root root 17858 10. Nov 09:55 /usr/lib/python3.11/site-packages/ansible_collections/community/digitalocean/plugins/modules/digital_ocean_firewall.py

```

is that something I can do anything about?

---

<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:** [December 2, 2023, 5:36pm UTC](https://forum.ansible.com/t/cant-display-module-documentation-with-ansible-doc/2701/2 "2023-12-02T17:36:39Z")

</div>

There is no module called `digital_ocean_firewall`. There is only a module called `community.digitalocean.digital_ocean_firewall`. So try running `ansible-doc community.digitalocean.digital_ocean_firewall`.

(The short name only works for modules that have already been in Ansible 2.9. ansible-core has a long list of redirects of such modules to their respective collections. For example, `digital_ocean_firewall_info` was already there in Ansible 2.9, so `ansible-doc digital_ocean_firewall_info` is the same as `ansible-doc community.digitalocean.digital_ocean_firewall_info`. But `digital_ocean_firewall` wasn’t there in Ansible 2.9, so `ansible-doc digital_ocean_firewall` doesn’t find the module.)

---

<div class="post-metadata">

**Author:** ![dulhaver](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/dulhaver/32/1061_2.png) [@dulhaver](https://forum.ansible.com/u/dulhaver)\
**Post date:** [December 3, 2023, 8:28am UTC](https://forum.ansible.com/t/cant-display-module-documentation-with-ansible-doc/2701/3 "2023-12-03T08:28:57Z")

</div>

thx. I just figured that out also. FQMN is king apparently !  
It just didn’t cross my mind even though it’s quite obvious.

---

<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:** [January 2, 2024, 8:29am UTC](https://forum.ansible.com/t/cant-display-module-documentation-with-ansible-doc/2701/4 "2024-01-02T08:29:15Z")

</div>

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