Jul. 10th, 2009

marnanel: (Default)
How we're generating documentation in telepathy-doc.

There are three kinds of docs: facing developer (like a tutorial... what tool?), facing user ("how do I format my USB key"... Mallard), and the stuff you format from the API (gtk-doc).

Developer docs
HIG, GTK Drawing Manual, ... etc
Example code, descriptive prose, i18n, multi-programming-language examples (how??), link to the API references

telepathy-doc
DocBook, gnome-doc-tools, svg figures, and a ton of Python to play with the xml.  DocBook purists don't like this (would rather do it in DocBook).



marnanel: (Default)
Six years ago today, Fin and I stood together and pledged our futures to one another. I'm still so glad we did so. I love you, sweetheart. Here's to many more. ♥

Profile

marnanel: (Default)
Monument

January 2022

S M T W T F S
      1
2345678
9101112131415
1617 1819202122
23242526272829
3031     

Most Popular Tags

Style Credit

Expand Cut Tags

No cut tags
Page generated Jul. 14th, 2025 01:18 pm
Powered by Dreamwidth Studios