Skip to content

Generated documentation for collection roles #44

@tallen116

Description

@tallen116

I stumbled upon this repository from some of the official collections . I love it for collections that will not be hosted on the Ansible Document site that want similar style docs. The roles I have wrote for my work, I have wrote module like YAML docs for the variables inside the README file.

Would there be any objections on including generated docs for role variables? It could be a .py file inside the role directory that would include a DOCUMENTATION block to parse.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions