[Buildbot-devel] build properties ...

[Steve Greenland]

On Wed, May 24, 2006 at 09:43:20AM -0700, Brian Warner wrote:
> I don't know of a good solution or tool to manage this process. My intention
> is to have the user's manual be the primary place where users can learn how
> to use the buildbot, but the user's manual is a lot younger than the rest of
> the code, so there are places where the primary documentation is still in the
> docstrings. And even after e.g. Waterfall has been documented in
> buildbot.texinfo, I'm loathe to delete the docstrings, because that's where a
> pydoc-using python programmer (as opposed to the User's Manual-using, er,
> user) would think to look for them. Really I want a way to have the
> docstrings get interpolated into the user's manual in the right page, so I
> only have to maintain one copy of those docs.
> 
> Any ideas?

I've lately been using ReStructured Text and the docutils tools for
local documentation, to generate PDF, HTML, and text versions of the
docs. RST is a minimal markup format -- easy to read and use in the raw,
but capable of generating nicely formatted docs.

It's intended for use in Python docstrings as well as standalone docs.

You might start at http://docutils.sourceforge.net/docs/index.html for
more info.

Steve


-- 
"Outlook not so good." That magic 8-ball knows everything! I'll ask
about Exchange Server next.
                           -- (Stolen from the net)