Difference between revisions of "User talk:Humitos/SugarToolkitDocs"

From Sugar Labs
Jump to navigation Jump to search
(→‎Workaround: new section)
Line 7: Line 7:
 
* Doxigen
 
* Doxigen
 
* <add your tool here>
 
* <add your tool here>
 +
 +
== Workaround ==
 +
 +
* Taken from the sugar-devel mailing list
 +
 +
<pre>
 +
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 ;)
 +
</pre>

Revision as of 12:18, 5 July 2012

Just a couple of suggestions. Make it a Makefile target and use a better theme like sphinxdoc :) --dnarvaez

Tool to be used

  • Sphinx
  • epydoc
  • Doxigen
  • <add your tool here>

Workaround

  • Taken from the sugar-devel mailing list
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 ;)