[Grok-doc] Updating docs to point to Distribute and how-to build the official Grok docs?
faassen at startifact.com
Sat Apr 30 18:46:54 EDT 2011
On 04/29/2011 12:40 AM, Kevin Teague wrote:
> I've been training a new person on Grok recently, and they got stuck
> with the "install Setuptools" step, because the Setuptools install
> process is a bit ... fuddly. I figured since Distribute is more actively
> maintained and has clearer install instructions, I'd update the Grok
> Tutorial to refer to Distribute over Setuptools. But it's been a while
> since I've worked on Grok docs, and I guess the way to generate the
> Sphinx docs has changed?
> I discovered documentation.cfg and ran "./bin/buildout -c
> documentation.cfg" to generate ./bin/generate_documentation but this
> generates documentation that lacks the Grok theme and the Tutorial isn't
> there ...
> Can anyone tell me how to create these docs correctly? Bonus points if
> the Grok README.txt which contains out-dated documentation generation
> instructions is updated.
> Oh, unless of course there are reasons why Grok still points to
> Setuptools vs Distribute beyond no one has gotten around to updating
> those docs yet ...
I'm fine with updating it to use distribute instead of setuptools, but
you'd really need to bring that particular topic up on grok-dev I think?
In general even for documentation questions I imagine you'll find more
people listening; Jan-Wijbrand might know what's up.
More information about the grok-doc