documentation of zeitgeist
Bug #497324 reported by
Markus Korn
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Zeitgeist Framework |
Fix Released
|
Wishlist
|
Markus Korn |
Bug Description
This is a kind of meta-bug to improve the documentation of zeitgeist, there are several tasks we should try to adress:
* rename doc/dbus, it is not a pure DBus API doc anymore, we already have the Datamodel documented etc.
* split the huge index.html in multiple smaller parts
* we should also document _zeitgeist/ as it getting more-and-more complex this is useful while doing development and might raise the coding standards
* add usage docs to zeitgeist-daemon
* add tutorials like "HowTo write a dataprovider", "Howto write an extension"
Changed in zeitgeist: | |
importance: | Undecided → Wishlist |
Changed in zeitgeist: | |
importance: | Wishlist → High |
Changed in zeitgeist: | |
importance: | High → Wishlist |
Changed in zeitgeist: | |
status: | In Progress → Fix Committed |
Changed in zeitgeist: | |
status: | Fix Committed → Fix Released |
To post a comment you must log in.
As of rev1243 of the attached branch I fixed the first two issues, and made a few other improvements.
I think the structure I've choosen there makes sense.
I also added a tiny sphinx extension which automatically creates documentation for the Manifestation and Interpretation Symbols, so we don't need the __doc__ property workaround anymore.