wiki:ChimeraPyDoc

Version 1 (modified by Darren Weber, 16 years ago) ( diff )

--

This is a way to get python code documentation for Chimera.

In Chimera-IDLE (on linux or *nix):

import os
os.makedirs('/var/tmp/chimera-pydoc')
os.chdir('/var/tmp/chimera-pydoc')
sharepath = os.path.join(os.getenv('CHIMERA'),'share')
import pydoc
pydoc.writedocs(sharepath)

It 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.

Note: See TracWiki for help on using the wiki.