Changes between Initial Version and Version 1 of ChimeraPyDoc


Ignore:
Timestamp:
Sep 17, 2010, 6:14:25 PM (16 years ago)
Author:
Darren Weber
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ChimeraPyDoc

    v1 v1  
     1
     2This is a way to get python code documentation for Chimera.
     3
     4In Chimera-IDLE (on linux or *nix):
     5{{{
     6import os
     7os.makedirs('/var/tmp/chimera-pydoc')
     8os.chdir('/var/tmp/chimera-pydoc')
     9sharepath = os.path.join(os.getenv('CHIMERA'),'share')
     10import pydoc
     11pydoc.writedocs(sharepath)
     12}}}
     13
     14It creates a lot of .html files in /var/tmp/chimera-pydoc/.  The .html files contain links to the source .py files.  Firefox will open the /var/tmp/chimera-pydoc directory and generate an index of all the files.  The pydoc html is fairly well cross-linked.