A little while ago I though it would be fun to use Sphinx and a theme derived from "Read the Docs" to build the lxml docs, and it worked rather well I think.
I put it on github: https://gregoryvigotorres.github.io/lxml_docs/index.html
The way I did it breaks some things and has some issues, but I think it can be made to work.
Is there any interest in pursuing this further and possibly replacing the endearing though somewhat dated looking and eccentric current documentation?
Gregory
Am .09.2017, 19:59 Uhr, schrieb Gregory gregory.vigo@gmail.com:
Is there any interest in pursuing this further and possibly replacing the endearing though somewhat dated looking and eccentric current documentation?
Most definitely, but you know how it is with open source projects. :-)
Looks great so far!
Charlie
I’m interested in contributing to documentation, especially for less technically savvy people like myself.
I opened up the Sphinx site at https://gregoryvigotorres.github.io/lxml_docs/index.html
On both Firefox and Chrome, the navigation panel crowds the main panel, and the leftmost characters are barely or not at all readable
A question that could do with more coverage is the matter of “undefined behaviour” while removing elements in lists. I still don’t quite understand under what circumstances undefined behaviour occurs and how to guard against it.
On 9/6/17, 12:11 PM, "lxml on behalf of Charlie Clark" <lxml-bounces@lxml.de on behalf of charlie.clark@clark-consulting.eu> wrote:
Am .09.2017, 19:59 Uhr, schrieb Gregory gregory.vigo@gmail.com:
> Is there any interest in pursuing this further and possibly replacing > the endearing though somewhat dated looking and eccentric current > documentation?
Most definitely, but you know how it is with open source projects. :-)
Looks great so far!
Charlie -- Charlie Clark Managing Director Clark Consulting & Research German Office Kronenstr. 27a Düsseldorf D- 40217 Tel: +49-211-600-3657 Mobile: +49-178-782-6226 _________________________________________________________________ Mailing list for the lxml Python XML toolkit - https://urldefense.proofpoint.com/v2/url?u=http-3A__lxml.de_&d=DwIGaQ&am... lxml@lxml.de https://urldefense.proofpoint.com/v2/url?u=https-3A__mailman-2Dmail5.webfact...
Gregory schrieb am 06.09.2017 um 19:59:
A little while ago I though it would be fun to use Sphinx and a theme derived from "Read the Docs" to build the lxml docs, and it worked rather well I think. I put it on github: https://gregoryvigotorres.github.io/lxml_docs/index.html The way I did it breaks some things and has some issues, but I think it can be made to work. Is there any interest in pursuing this further and possibly replacing the endearing though somewhat dated looking and eccentric current documentation?
Thanks for doing that. I'd be happy to see the documentation improve in that direction, but it needs to be an improvement. Meaning, it must be at least as good as the current documentation, easy to navigate, etc. If (or as soon as) that's the case, I'll be happy to accept a pull request.
Stefan
participants (4)
-
Charlie Clark -
Gregory -
Martin Mueller -
Stefan Behnel