Have a look at the self-userdoc target in NAnt.build in core. The same
thing needs to be added to the nant contrib build file. it uses the
custom documenter NDoc.Documenter.NAnt.dll which is built as part of the
main NAnt build process.
Ian
<target name="self-userdoc" depends="init">
<!-- use ndoc and NAnt.Documenter to build user doc -->
<ndoc>
<assemblies basedir="${build.dir}/bin">
<includes name="NAnt.Core.dll"/>
<includes name="*Tasks.dll"/>
</assemblies>
<documenters>
<documenter name="NAntTask">
<property name="OutputDirectory"
value="${build.dir}/doc/help/tasks"
/>
</documenter>
</documenters>
</ndoc>
<!-- copy images so we can preview userdoc and have it look
right -->
<copy file="doc/style.css" todir="${build.dir}/doc" />
<copy file="doc/arrow.gif" todir="${build.dir}/doc" />
<echo message="Preview task references:
file://${build.dir}/doc/help/tasks/index.html"/>
</target>
>I see a couple of things in the 'build' directory when NAntContrib is built.
>In the 'docs/MSDN' directory are all the MSDN style html files. In the main
>build directory is the NAnt.Contrib.Tasks.xml file, which looks like it
>contains what I am looking for, but how can it be translated into the html
>docs? Do we have to do that manually using NDoc?
>
>-Griffin
>
>-----Original Message-----
>From: [EMAIL PROTECTED]
>[mailto:[EMAIL PROTECTED]]On Behalf Of
>Ian MacLean
>Sent: Tuesday, October 15, 2002 7:18 PM
>To: Griffin Caprio; [EMAIL PROTECTED]
>Subject: Re: [NAntC-Dev] How-to Docs?
>
>
>Griffin Caprio wrote:
>
>
>
>>I meant actual usage documents, not api stuff. Currently, when NAntContrib
>>builds, it does build a MSDN-style help file, which is good for
>>
>>
>manipulating
>
>
>>the library itself. But not actually using the tasks in build files.
>>
>>
>>
>>
>ndoc is also used with a custom documenter to build the end user doc.
>All the pages at http://nant.sourceforge.net/help/tasks/index.html weer
>built this way.
>
>Ian
>
>
>
>>-Griffin
>>
>>-----Original Message-----
>>From: Ian MacLean [mailto:[EMAIL PROTECTED]]
>>Sent: Tuesday, October 15, 2002 12:59 PM
>>To: Griffin Caprio
>>Subject: Re: [NAntC-Dev] How-to Docs?
>>
>>
>>Griffin Caprio wrote:
>>
>>
>>
>>
>>
>>>Is there any chance of documentation being released for how to use the
>>>
>>>
>>>
>>>
>>tasks
>>
>>
>>
>>
>>>in the nantcontrib project?
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>Sure. As long as the code comments have been setup properly we'll be
>>able to generate the same NDoc documentation we do for core.
>>
>>Ian
>>
>>
>>
>>
>>
>>>-Griffin
>>>
>>>
>>>
>>>-------------------------------------------------------
>>>This sf.net email is sponsored by:ThinkGeek
>>>Welcome to geek heaven.
>>>http://thinkgeek.com/sf
>>>_______________________________________________
>>>NAntContrib-Developer mailing list
>>>[EMAIL PROTECTED]
>>>https://lists.sourceforge.net/lists/listinfo/nantcontrib-developer
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>
>>
>>
>>
>>-------------------------------------------------------
>>This sf.net email is sponsored by: viaVerio will pay you up to
>>$1,000 for every account that you consolidate with us.
>>http://ad.doubleclick.net/clk;4749864;7604308;v?
>>http://www.viaverio.com/consolidator/osdn.cfm
>>_______________________________________________
>>NAntContrib-Developer mailing list
>>[EMAIL PROTECTED]
>>https://lists.sourceforge.net/lists/listinfo/nantcontrib-developer
>>
>>
>>
>>
>
>
>
>
>
>-------------------------------------------------------
>This sf.net email is sponsored by: viaVerio will pay you up to
>$1,000 for every account that you consolidate with us.
>http://ad.doubleclick.net/clk;4749864;7604308;v?
>http://www.viaverio.com/consolidator/osdn.cfm
>_______________________________________________
>NAntContrib-Developer mailing list
>[EMAIL PROTECTED]
>https://lists.sourceforge.net/lists/listinfo/nantcontrib-developer
>
>
-------------------------------------------------------
This sf.net email is sponsored by: viaVerio will pay you up to
$1,000 for every account that you consolidate with us.
http://ad.doubleclick.net/clk;4749864;7604308;v?
http://www.viaverio.com/consolidator/osdn.cfm
_______________________________________________
NAntContrib-Developer mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/nantcontrib-developer
