[Ironpython-users] Code docs generation for Python-exposed .NET API

[Michael Foord]

On 01/09/2011 10:04, Igor Brejc wrote:
> Hi,
>
> I plan to write a wrapper API in C# that will be used by IronPython 
> scripts. The API will adhere to Python's coding & design style etc.
>
> My question: what would be the best approach for generating code 
> documentation in HTML that would look & feel like it's for native 
> Python API? Sandcastle seems a bit too .NETish, is there something 
> that would resemble sphinx's generated documentation?

You could use reflection to pull out the types / call signatures from 
the assembly and use that to generate a restructured text skeleton for 
pulling into sphinx.

There's a script here that generates skeleton python files (just 
containing the api) from .net assemblies. This script is used by the 
Wing IDE for providing code completion for .NET, but it should be 
possible to "repurpose" it:

http://www.voidspace.org.uk/ironpython/wing-how-to.shtml#generating-pi-files

All the best,

Michael Foord
>
> Thanks for any hints,
> Igor Brejc
>
>
> _______________________________________________
> Ironpython-users mailing list
> Ironpython-users at python.org
> http://mail.python.org/mailman/listinfo/ironpython-users


-- 
http://www.voidspace.org.uk/

May you do good and not evil
May you find forgiveness for yourself and forgive others
May you share freely, never taking more than you give.
-- the sqlite blessinghttp://www.sqlite.org/different.html


-- 
http://www.voidspace.org.uk/

May you do good and not evil
May you find forgiveness for yourself and forgive others
May you share freely, never taking more than you give.
-- the sqlite blessing http://www.sqlite.org/different.html

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/ironpython-users/attachments/20110901/e357ea35/attachment.html>