Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 1.24 KB

APIDocs.mediawiki

File metadata and controls

23 lines (18 loc) · 1.24 KB
Raw

Twisted API Documentation

This page describes how to generate the API docs for the Twisted web site.

You will need the latest Twisted release unpacked and the latest version of pydoctor

Steps

  1. Modify template.tpl to include the Google Analytics !JavaScript (which can be found in the source of any trac page).
  2. Run an interactive Python session that goes something like this:


     Be sure to use the tag which corresponds to the version of Twisted the docs are being generated for.  Note that if your working is the Twisted source directory you checked out, then ''that'' version of `APIBuilder` will be used!


  3. Upload the resulting `apidocs` directory to www-data@cube.  Use `tar cx apidocs | ssh www-data@twistedmatrix.com tar xv` or something.
  4. Put the apidocs directory into the appropriate location beneath vhosts/twistedmatrix.com/documents/ (eg 8.2.0/api)
  5. If desired, update the `current` symlink.