Changes between Version 7 and Version 8 of ReviewingDocumentation


Ignore:
Timestamp:
08/21/2013 02:20:30 PM (12 months ago)
Author:
zigg_
Comment:

use admin script to build apidocs instead of pydoctor

Legend:

Unmodified
Added
Removed
Modified
  • ReviewingDocumentation

    v7 v8  
    6464 * [http://www.divmod.org/trac/wiki/DivmodNevow nevow] - pydoctor's HTML generation side uses Nevow templates 
    6565 
    66 Once everything is installed, generate the docs with a command like:[[BR]] 
    67 `pydoctor --quiet --make-html --system-class pydoctor.twistedmodel.TwistedSystem --add-package /path/to/my-code-dir/Twisted/trunk/twisted` 
     66Once everything is installed, generate the docs with the build-apidocs admin script like so: 
    6867 
    69 This produces a folder called `apidocs` in your current working directory. You can then browse from the entry points to the docs in a web browser via the URL 
     68`bin/admin/build-apidocs /path/to/my-code-dir/Twisted/trunk apidocs` 
     69 
     70The above produces a folder called `apidocs` in your current working directory. You can then browse from the entry points to the docs in a web browser via the URL 
    7071 
    7172`file:///path/to/apidocs/index.html` 
    7273 
    73 If everything looks good, submit a patch as described [wiki:TwistedDevelopment#SubmittingaPatch here] 
     74If everything looks good, submit a patch as described [wiki:TwistedDevelopment#SubmittingaPatch here]. 
    7475 
    7576=== Editing man pages ===