Mercurial Kick Start

Peter Arrenbrecht peter.arrenbrecht at gmail.com
Thu Apr 8 07:52:45 CDT 2010


On Wed, Mar 31, 2010 at 12:43 AM, Martin Geisler <mg at lazybytes.net> wrote:
>
> Technical details: all the shell script examples are executed and the
> output is matched up against the expected output. This is just like
> Bryan's Definitive Guide and Peter's pbranch documentation. I just
> embedded it in to reStructuredText since I know that the best and since
> we have talked about using such a system for our own documentation.
>
> The repository is here:
>
>  http://bitbucket.org/mg/kick-start/
>
> The Makefile will build the HTML files. It requires a Linux-like system
> with rst2html, dot, svn, convert, and standard tools.
>
> The screenshots are also automatic (I guess that code could be handy for
> the TortoiseHg documentation). Resize your 'hgtk log' the way you want
> it before starting the build -- the screenshots will use the same size
> as your last 'hgtk log' window. I looked briefly at the files under
> ~/.tortoisehg to see where the size is stored. The idea was that I would
> ship settings files for the sizes needed in order to make things more
> self-contained. But I didn't immediatedly find the right file and
> decided that the current system is good enough :-)

Woohoo - automated screenshots even! Love it! Now if we can hook this
approach up with the bitbucket wiki, we might get easily editable docs
that are still shelltested.
-parren


More information about the Mercurial-devel mailing list