使用puppet-doc生成模块描述

Question

我可以为我的模块类成功生成Puppet文档（使用puppet-doc）但我还想包含一个模块级文档（类似于http://docs.puppetlabs.com/puppet/3/reference/modules_documentation.html。）我试着放一个README.md ，README.markdown，[modulename] .md或[modulename] .markdown在模块顶层但没有成功。

我错过了阅读文档的内容是什么？

Answer 1

PuppetLabs处的文档表明README受到尊重，而不是README.md或.markdown。

看作puppet doc基本上是rdoc，它不支持典型的markdown，而是需要一个rdoc格式，或者只是纯文本。