[PATCH 4 of 4 v2] gendoc: automatically create help for default extensions

Erik Zielke ez at aragost.com
Tue Oct 19 10:05:54 CDT 2010


Yes, that probably a good idea.

2010/10/19 Mads Kiilerich <mads at kiilerich.com>

> On 10/19/2010 02:03 PM, Erik Zielke wrote:
>
>> # HG changeset patch
>> # User Erik Zielke<ez at aragost.com>
>> # Date 1287489003 -7200
>> # Node ID 4952cbfebf8d090583ba4111417a8fb7ae274818
>> # Parent  2006cff2cdf323e3edab2f329ada4143e0cfef61
>> gendoc: automatically create help for default extensions.
>>
>> Adds a section in the hg.1 manpage and corresponding hg.1.html
>> file. Each extension is listed with its module docstring, followed by
>> the commands defined by that extendsion.
>>
>> Creates help for extensions by extracting doc strings from the extension
>> modules
>> and its commands.
>>
>>
>
>  -def commandprinter(ui, cmdtable):
>> +    section(_("Extensions"))
>> +    ui.write("""
>> +
>> +.. contents::
>> +   :local:
>> +   :depth: 1
>> +
>> +""")
>>
>
> Perhaps it should be mentioned here that this only lists the extensions
> distributed with Mercurial and that help for non-standard extensions is
> available in the help system.
>
> /Mads
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://selenic.com/pipermail/mercurial-devel/attachments/20101019/20f8af36/attachment.htm>


More information about the Mercurial-devel mailing list