ansible-docgen
ansible-docgen copied to clipboard
Need an option to generate documentation with filename of choice
Currently, ansible-docgen always creates a README.md as the default markdown doc. User should be given a choice to specify a filename of his choice. Something like the below :
ansible-docgen -f playbook_info
...generates playbook_info.md
In my case, the README is a file containing info about the general purpose of a set of playbooks OR roles in a folder. While I would love to have the doc telling me about the specifics/summary of each playbook/role , I wouldn't want it to replace the README.md
Of course, it could be argued that the original README can be moved to a different filename - but somehow I would like to have original README as the readme a user should be directed to.
Thats an easy feature to put into the next release. Hopefully will have time soon to work on this.
Adding as a goal for v1.0.0