Sugarlabs already has a sphinx instance, although it is a bit out of date: <a href="http://doc.sugarlabs.org/sphinx/">http://doc.sugarlabs.org/sphinx/</a><br><br>It also has a epydoc instance: <a href="http://doc.sugarlabs.org/epydocs/">http://doc.sugarlabs.org/epydocs/</a> (a.k.a <a href="http://api.sugarlabs.org">api.sugarlabs.org</a>)<br>

<br>I previously kept a Doxygen parsing of the Sugar toolkit, largely because I know how to make nice dependancy graphs with Doxygen.  This currently is not hosted anywhere.<br><br>In general each documentation tool I have used has a slightly different style for comments to state things like '@param input_item Describes this input" and "@returns A XYZ object if successful; null on failure".  So you should decide on the tool to use that can do everything you want before you formally go annotating the code base.<br>

<br><br><div class="gmail_quote">On Thu, Jul 5, 2012 at 9:28 AM, Gary Martin <span dir="ltr"><<a href="mailto:garycmartin@googlemail.com" target="_blank">garycmartin@googlemail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

Hi Manuel,<br>
<div class="im"><br>
On 5 Jul 2012, at 12:30, Manuel Kaufmann <<a href="mailto:humitos@gmail.com">humitos@gmail.com</a>> wrote:<br>
<br>
> Hello,<br>
><br>
> I think it would be really great to have something similar to this:<br>
><br>
> * <a href="http://mkaufmann.com.ar/%7Ehumitos/sugar-toolkit-gtk3/" target="_blank">http://mkaufmann.com.ar/~humitos/sugar-toolkit-gtk3/</a><br>
><br>
> What do you think?<br>
<br>
</div>Looks pretty :)<br>
<br>
My quick and dirty solution for browsable docs are to just hop into the terminal on an XO and type pydoc -p 8080 and then point Browse to localhost:8080. Now that we have moved to webkit I'm really tempted to wrap this up as a little webkit activity to get to the dev docs with no geeking around ;)<br>


<br>
And yes, making sure doc strings are useful and stay  date makes this much more useful!<br>
<br>
Regards,<br>
--Gary<br>
<div class="HOEnZb"><div class="h5"><br>
><br>
> This is what I did to get that kind of documentation<br>
><br>
> sudo yum install python-sphinx<br>
><br>
> sphinx-apidoc --doc-author="Manuel Kaufmann" --full<br>
> --doc-version="0.96" --doc-release="0.96" --doc-project="Sugar Toolkit<br>
> Gtk3"  --output-dir="doc" .<br>
> cd doc<br>
> make html<br>
><br>
> I don't know if we have something like that, if yes, please let me<br>
> know before start doing some work on this.<br>
><br>
> Thanks, see you<br>
><br>
> --<br>
> Kaufmann Manuel<br>
> Blog: <a href="http://humitos.wordpress.com/" target="_blank">http://humitos.wordpress.com/</a><br>
> Porfolio: <a href="http://fotos.mkaufmann.com.ar/" target="_blank">http://fotos.mkaufmann.com.ar/</a><br>
> PyAr: <a href="http://www.python.com.ar/" target="_blank">http://www.python.com.ar/</a><br>
> _______________________________________________<br>
> Sugar-devel mailing list<br>
> <a href="mailto:Sugar-devel@lists.sugarlabs.org">Sugar-devel@lists.sugarlabs.org</a><br>
> <a href="http://lists.sugarlabs.org/listinfo/sugar-devel" target="_blank">http://lists.sugarlabs.org/listinfo/sugar-devel</a><br>
_______________________________________________<br>
Sugar-devel mailing list<br>
<a href="mailto:Sugar-devel@lists.sugarlabs.org">Sugar-devel@lists.sugarlabs.org</a><br>
<a href="http://lists.sugarlabs.org/listinfo/sugar-devel" target="_blank">http://lists.sugarlabs.org/listinfo/sugar-devel</a><br>
</div></div></blockquote></div><br>