[Telepathy] new spec parser/doc generator

Davyd Madeley davyd.madeley at collabora.co.uk
Mon Feb 16 20:49:37 PST 2009


Hey All,

In order to improve the readability of the telepathy-spec, I've put a
couple of days into overhauling how the HTML is generated.

http://people.collabora.co.uk/~davyd/new-look-spec/index.html

Previously HTML was generated from an XSL stylesheet. It's now generated
using a Python program and Cheetah HTML templates, making it reasonably
trivial to tweak the layout of the spec.

In addition, a new Python module 'specparser' is available. This module
reads in a spec file and generates nice attractive Python data
structures that you can iterate through without needing to know about
XML. The idea is that this module becomes the basis for code generators,
etc.

Branch is here:

http://git.collabora.co.uk/?p=user/davyd/telepathy-spec-davyd.git;a=shortlog;h=refs/heads/new-spec-parser

TODO:

      * write unit tests for specparser against the current test.xml in
        telepathy-spec
      * abstract HTML specific method calls out of specparser into
        doc-generator.py
      * tweak CSS (e.g. anchors currently appear under the floating
        title -- not optimal
      * check Python 2.3 compliance of specparser

Feedback appreciated.

--d

-- 
Davyd Madeley

Collabora Ltd., Perth, Australia
http://www.collabora.co.uk/



More information about the telepathy mailing list