puppet - 使用 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，它不支持典型的降价，而是需要 rdoc 格式，或者只是纯文本。