Adding README to puppetdoc?

11 views
Skip to first unread message

macwall

unread,
Jun 21, 2011, 12:20:42 PM6/21/11
to puppet...@googlegroups.com
Hi all,

I'm working on creating all of our Documentation using puppetdoc (version 0.25 from EPEL on CentOS 5.5).

We are including all of our modules at the same time using the --modulepath directive, however our README file is not being picked up.

Is there any way to include the README file as part of the documentation which is being generated?

We are currently using the following command:

puppet doc --mode rdoc -o ../docs --verbose --config /etc/puppet/puppet.conf --modulepath modules/:systems/

The README sits above the modules and systems directory.

Thanks in advance,

Matt

Felix Frank

unread,
Jul 19, 2011, 4:41:41 AM7/19/11
to puppet...@googlegroups.com
Hi,

On 06/21/2011 06:20 PM, macwall wrote:
> I'm working on creating all of our Documentation using puppetdoc
> (version 0.25 from EPEL on CentOS 5.5).

sorry for following up late.

My experience with puppetdoc 0.25.5 was that it's terribly broken.
I suggest to install a 2.6 machine somewhere and feed your manifests to
its local puppetdoc instead.

HTH,
Felix

Reply all
Reply to author
Forward
0 new messages