163
edits
Changes
Jump to navigation
Jump to search
Created page with ". == Summary == Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your bro..."
[[Category:Feature|.]]
== Summary ==
Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your browser.
== Owner ==
* Name: [[User:SAMdroid|Sam P.]]
* Email: @sam.today
== Current status ==
* Targeted release: 0.108
* Last updated: 8/Aug
* Percentage of completion: 10%
== Detailed Description ==
* Create a sphinx configuration file so we can have a website (DONE)
* Translate existing docs into 1 consistent style
* Write docs for all other public ''sugar3'' classes
== Benefit to Sugar ==
This will allow developers to create activities more eaisly. They will no longer have to look thought the source code th understand how the api works, they will instead (hopefully) have understandable docs with good working code samples.
== Scope ==
This will require lots of changes in the docstrings. However, no changes will be made to code that runs on users machines.
==UI Design==
Example docs: http://dev.sam.today/ http://dev.sam.today/sugar3.graphics.alert/ http://dev.sam.today/sugar3.graphics.animator/
== How To Test ==
* View docs
* Try code samples
== User Experience ==
None for sugar users.
== Dependencies ==
None
== Contingency Plan ==
None
== Release Notes ==
The Sugar toolkit now has imporved API documentation coverage. View our docs here: dev.sam.today (real url when it is done of course)
== Comments and Discussion ==
* https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/248
* ''Link to the discussion of this feature on lists.sugarlabs.org''
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]] <!-- This adds a link to the "discussion" tab associated with your page. This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->
== Summary ==
Add developer API documentation to sugar-toolkit-gtk3 in a consistent format. Then, create a site to make the docs available in your browser.
== Owner ==
* Name: [[User:SAMdroid|Sam P.]]
* Email: @sam.today
== Current status ==
* Targeted release: 0.108
* Last updated: 8/Aug
* Percentage of completion: 10%
== Detailed Description ==
* Create a sphinx configuration file so we can have a website (DONE)
* Translate existing docs into 1 consistent style
* Write docs for all other public ''sugar3'' classes
== Benefit to Sugar ==
This will allow developers to create activities more eaisly. They will no longer have to look thought the source code th understand how the api works, they will instead (hopefully) have understandable docs with good working code samples.
== Scope ==
This will require lots of changes in the docstrings. However, no changes will be made to code that runs on users machines.
==UI Design==
Example docs: http://dev.sam.today/ http://dev.sam.today/sugar3.graphics.alert/ http://dev.sam.today/sugar3.graphics.animator/
== How To Test ==
* View docs
* Try code samples
== User Experience ==
None for sugar users.
== Dependencies ==
None
== Contingency Plan ==
None
== Release Notes ==
The Sugar toolkit now has imporved API documentation coverage. View our docs here: dev.sam.today (real url when it is done of course)
== Comments and Discussion ==
* https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/248
* ''Link to the discussion of this feature on lists.sugarlabs.org''
* See [[{{TALKPAGENAME}}|the discussion tab for this feature.]] <!-- This adds a link to the "discussion" tab associated with your page. This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->