[lxml-dev] lxml documentation volunteers?

[Martijn Faassen]

Hi there,

I think it's time to give the lxml documentation a reworking, in 
particular our API documentation. It must become more clear for users 
what is in the API; I find myself having to look at the code or do a 
dir() far too often to find whether a feature is supported.

What I would wish for is API documentation similar to the module 
documentation on python.org. Something close to that would be familiar 
for users so they can get started with lxml quickly. I hope we can also 
continue to doctest code samples in the documentation.

For completeness I think we would need to integrate the existing 
ElementTree API documentation so we have a one-stop-shop for people 
using lxml, instead of the scattered situation now. We should mark where 
an API is taken from ElementTree so that people can easily write 
compatible code.

Such API documentation would also help us identify possible ElementTree 
APIs we haven't implemented yet, and it might also suggest APIs we want 
to imply that are currently missing.

Any volunteers for this work?

Regards,

Martijn