Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generated documentation for collection roles #44

Open
tallen116 opened this issue Nov 14, 2020 · 0 comments
Open

Generated documentation for collection roles #44

tallen116 opened this issue Nov 14, 2020 · 0 comments

Comments

@tallen116
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant