wiki:TwistedLore

Version 10 (modified by thijs, 5 years ago) (diff)

move tickets section (#4211)

Twisted Lore

Lore is a documentation generator. It is used to generate the Twisted documentation. It produces output that looks like this.

Lore processes simple HTML documents (and troff-formatted man-pages) into slightly more complex HTML documents as well as LaTeX files (which can, in turn, be used to produce printed documentation such as the Twisted core documentation "book"). Its features include linking and syntax-highlighting source listings, "table of contents" generation, and embedding diagrams. Where they are not automatic, these features are invoked by annotating elements in the input with special class attributes, which leaves the input a valid HTML document that can be viewed without the help of lore.

Source listings can be maintained in external files, for easier editing, testing, and debugging of documentation examples.

Twisted Lore is available under the MIT Free Software licence.

Download

See the Downloads page.

Documentation

Documentation is available for Twisted Lore. An API reference of Twisted and all subprojects is also available.

Contact

Subscribe to the twisted-python mailing list or visit the #twisted channel on irc.freenode.net to ask questions.

Tickets

Report a bug or request a feature using the issue tracker (registration required), or browse Twisted Lore tickets.