[lxml-dev] Call for contribution towards lxml 1.3

[Stefan Behnel]

Martijn Faassen wrote:
> Stefan Behnel wrote:
>> But there is another area where help is appreciated. A very important area in
>> fact: *documentation*. While there is quite a bit of documentation both on
>> ElementTree and lxml, there are certainly places where lxml's API and its way
>> of doing XML are hard to access, especially for new users and those who have a
>> fixed (should I say: Java-ish?) mindset on XML. If you want to contribute,
>> helping out in this area is warmly appreciated. Here are a few ideas that
>> would be truely helpful for lxml's user base.
> 
> Besides the topics Stefan mentioned, I think we should consider creating 
>   complete API documentation for lxml looking similar to what's on 
> www.python.org for the core library.

Definitely. Docstrings are an important point here. They serve both for
online-docs via help() and can be used to extract docs into other formats.

I'm not aware of any doc-gen tools that reads Pyrex, though. While we could
import the module and see what we get, we'd also need support for figuring out
the signatures of methods and functions, which C-classes don't provide.

Any ideas?

Stefan