Docs fragments allow you to document common parameters of multiple plugins or modules in a single place.
You can add a custom docs fragment by dropping it into a doc_fragments directory adjacent to your collection or role, just like any other plugin.
Only collection developers and maintainers use docs fragments. For more information on using docs fragments, see Documentation fragments or Using documentation fragments in collections.
See also
An introduction to creating Ansible modules
A guide to creating Ansible collections
Got questions? Need help? Want to share your ideas? Visit the Ansible communication guide
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/plugins/docs_fragment.html