Docs fragments

Docs fragments allow you to document common parameters of multiple plugins or modules in a single place.

Enabling docs fragments

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.

Using docs fragments

Only collection developers and maintainers use docs fragments. For more information on using docs fragments, see module_docs_fragments or docfragments_collections.

seealso:

developing_modules_general An introduction to creating Ansible modules

developing_collections An guide to creating Ansible collections User Mailing List Have a question? Stop by the google group!

communication_irc How to join Ansible chat channels