[Sugar-devel] sugar-toolkit-gtk3's Sphinx documentation

Gary Martin garycmartin at googlemail.com
Thu Jul 5 09:28:23 EDT 2012


Hi Manuel,

On 5 Jul 2012, at 12:30, Manuel Kaufmann <humitos at gmail.com> wrote:

> Hello,
> 
> I think it would be really great to have something similar to this:
> 
> * http://mkaufmann.com.ar/~humitos/sugar-toolkit-gtk3/
> 
> What do you think?

Looks pretty :)

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 ;)

And yes, making sure doc strings are useful and stay  date makes this much more useful!

Regards,
--Gary

> 
> This is what I did to get that kind of documentation
> 
> sudo yum install python-sphinx
> 
> sphinx-apidoc --doc-author="Manuel Kaufmann" --full
> --doc-version="0.96" --doc-release="0.96" --doc-project="Sugar Toolkit
> Gtk3"  --output-dir="doc" .
> cd doc
> make html
> 
> I don't know if we have something like that, if yes, please let me
> know before start doing some work on this.
> 
> Thanks, see you
> 
> -- 
> Kaufmann Manuel
> Blog: http://humitos.wordpress.com/
> Porfolio: http://fotos.mkaufmann.com.ar/
> PyAr: http://www.python.com.ar/
> _______________________________________________
> Sugar-devel mailing list
> Sugar-devel at lists.sugarlabs.org
> http://lists.sugarlabs.org/listinfo/sugar-devel


More information about the Sugar-devel mailing list