Twisted API Documentation

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

You will need a checkout of the latest release of Twisted.

Steps

1. In a checkout of WebSite (< svn://svn.twistedmatrix.com/svn/WebSite/trunk>), in the trunk/vhosts/twistedmatrix.com/documents/current directory, run:

   % pydoctor -c twisted.cfg -o twisted-doc-model
   ...
   % bzip2 twisted-doc-model 
   % svn commit twisted-doc-model.bz2
   

This will generate API documentation for the latest release of Twisted.

2. If there has been a new release, edit twisted.cfg to point to that release.

3. Now, ssh to pyramid.

% sudo su - www-data
% pwd
/var/www
% svn up WebSite
% cd WebSite/vhosts/twistedmatrix.com
% ./generate-apidocs.sh newapi

4. Look at the output in documents/current/newapi and make sure it looks alright, then replace the existing documentation:

% mkdir documents/<old version number>
% mv documents/current/api documents/<old version number>/
% mv documents/current/newapi documents/current/api

5. If there have been useful pydoctor changes, make sure to update your pydoctor checkout/installation on both hosts before running it.

HOORAY