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

Martijn Faassen faassen at startifact.com
Thu Jan 13 01:46:00 EST 2011

Hi there,

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.



More information about the Grok-dev mailing list