You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

Docs fragments

Enabling docs fragments
Using 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 Ansible modules: 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!
Real-time chat: How to join Ansible chat channels