How to write documentation for modules?
I have 2 quite large puppet modules.
My problem - how to create documentation for puppet modules, that will be:
- Easy to maintain
- Easy to read
- Easy to write
At this moment I created README file with a lot of plain text + couple of comments on top of each class file.
What I would like to achieve - keep all comments in code, not on the top, or bottom - but inside of code, and use some kind of tool that will generate beautiful HTML/PlainText documents basing on them.
Is anything like this for Puppet? E.g. like doxygen