[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Chicken-users] How do I document eggs?

From: Christian Kellermann
Subject: Re: [Chicken-users] How do I document eggs?
Date: Sun, 11 Mar 2012 09:14:19 +0100
User-agent: Mutt/1.5.21 (2010-09-15)

Hi Mark,

* Mark Carter <address@hidden> [120310 23:06]:
> chicken-doc looks like a useful feature, but how should I document my 
> eggs to use it? The eggdoc egg says not to document eggs using 
> eggdoc anymore, but to use the chicken wiki. My egg (well actually, it's 
> just a module made into an extension) just resides in a directory, 
> however. Does that mean there's no real way of documenting it?

You can nonetheless write the docs using the wiki markup just like
in the wiki and add that page to your chicken-doc index. You will
need the chicken-doc-admin egg for that. Then add the directory
like any other egg dir. I think that should work.

Kind regards,


Who can (make) the muddy water (clear)? Let it be still, and it will
gradually become clear. Who can secure the condition of rest? Let
movement go on, and the condition of rest will gradually arise.
 -- Lao Tse. 

reply via email to

[Prev in Thread] Current Thread [Next in Thread]