documentation of zeitgeist

Bug #497324 reported by Markus Korn on 2009-12-16
10
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"

Markus Korn (thekorn) on 2009-12-16
Changed in zeitgeist:
importance: Undecided → Wishlist
Markus Korn (thekorn) wrote :

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.

Changed in zeitgeist:
status: New → In Progress
assignee: nobody → Markus Korn (thekorn)

Can we have the URL links of the Manifestation and Interpretation types like we used to? They are mighty handy because the Nepomuk URLs actually point at the docs.

Other than that - mighty good work! The docs look sweet!

Markus Korn (thekorn) wrote :

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 <email address hidden>
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.
------------------------------------------------------------

Seif Lotfy (seif) wrote :

How much of this is done?
AFAIK tutorials are done
has the index html been split yet?

Seif Lotfy (seif) on 2010-03-02
Changed in zeitgeist:
importance: Wishlist → High
Seif Lotfy (seif) on 2010-03-02
Changed in zeitgeist:
importance: High → Wishlist
Seif Lotfy (seif) on 2010-04-25
Changed in zeitgeist:
status: In Progress → Fix Committed
Changed in zeitgeist:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers