zeitgeist team mailing list archive

[Markus Korn <thekorn@xxxxxx>]

Good point, I just added the urls to the symbols.
And after seeing "mighty" two times in the last comment I decided to merge this first step into lp:zeitgeist as this make the docs available for everyone.

------------------------------------------------------------
revno: 1234 [merge]
committer: Markus Korn <thekorn@xxxxxx>
branch nick: trunk
timestamp: Wed 2009-12-16 20:46:46 +0100
message:
  * Started restructuring the documentation (LP: #497324)
     - splitted up the huge index page into smaller bits
     - shpinx does now generate the documentation for Symbols
     - change things such that we cannot only ship a DBus API documentation
       but also development related docs about our engine.
  * fix some testcases, because of the changes to the documentation framework 
    the docstring if Symbols are looking different now.
------------------------------------------------------------

-- 
documentation of zeitgeist
https://bugs.launchpad.net/bugs/497324
You received this bug notification because you are a member of Zeitgeist
Developers, which is the registrant for Zeitgeist Framework.

Status in Zeitgeist Framework: In Progress

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"