[Grok-dev] the plan for moving documentation from the grok package to groktoolkit

Jan-Wijbrand Kolman janwijbrand at gmail.com
Thu Jan 13 03:39:13 EST 2011

On 1/13/11 7:46 AM, Martijn Faassen wrote:
> On 01/12/2011 04:11 PM, Jan-Wijbrand Kolman wrote:
>> This documentation tree requires sphinx infrastructure resembling that
>> what currently is in the doc directory of grok. It also requires ways
>> for integrating (parts of) the API documentations into this higher-level
>> documentation.
>> This is quite an undertaking, but I will try to dedicate some time to
>> this to get this started.
> This sounds like a good plan; it's true API docs in particular need to
> stay close to the package where the API is defined (or at least where
> it's published, the Grok package may publish an API defined in an
> underlying package).
> I plan to do some research on how to separate out "close-to-package"
> docs from "project" docs in the context of Fanstatic; hopefully we can
> apply the knowledge here too.

OK great! Please let me know how you fare - my luxurious slot of time to 
dedicate to Grok is nearing an end, so I have to prioritize what I can 
do to get a release out next week.

regards, jw

More information about the Grok-dev mailing list