Ticket #4500 enhancement new
Use Sphinx for Twisted Documentation
|Reported by:||khorn||Owned by:||khorn|
|Priority:||normal||Milestone:||Lore to Sphinx|
|Cc:||thijs, gtaylor, hawkowl@…||Branch:||
(diff, github, buildbot, log)
Description (last modified by thijs) (diff)
Twisted should use Sphinx for all long-form documentation (basically everything but API docs).
This ticket is for handling that conversion.
Comments, discussion, and reviews on this ticket should be about overall issues relating to the conversion.
Markup errors in the conversion branch should be handled in separate "markup review" tickets. This is so we can break up the task of manually reviewing all the markup and one person doesn't get stuck doing it all.
Markup review tickets will be listed in the comments of this ticket once there is a branch to review. (after the 10.1 release)
The lore2sphinx tool can be downloaded from https://bitbucket.org/khorn/lore2sphinx.