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 Documentation fragments or Using documentation fragments in collections.

See also

Developing modules

An introduction to creating Ansible modules

Developing collections

A guide to creating Ansible collections

User Mailing List

Have a question? Stop by the Google group!

Real-time chat

How to join Ansible chat channels