org.python.indexer.demos

Class HtmlDemo

java.lang.Object

org.python.indexer.demos.HtmlDemo

public class HtmlDemo
extends java.lang.Object

Simple proof-of-concept demo app for the indexer. Generates a static-html cross-referenced view of the code in a file or directory, using the index to create links and outlines.

The demo not attempt to show general cross references (declarations and uses of a symbol) from the index, nor does it display the inferred type information or generated error/warning diagnostics. It could be made to do these things, as well as be made more configurable and generally useful, with additional effort.

Run it from jython source tree root dir with; e.g., to index /usr/lib/python2.4/email

 ant jar && java -classpath ./dist/jython.jar org.python.indexer.demos.HtmlDemo /usr/lib/python2.4 /usr/lib/python2.4/email
 

Fully indexing the Python standard library may require a more complete build to pick up all the dependencies:

 rm -rf ./html/ && ant clean && ant jar && ant jar-complete && java -classpath ./dist/jython.jar org.python.indexer.demos.HtmlDemo /usr/lib/python2.4 /usr/lib/python2.4
 

You can alternately use Jython's version of the Python library. The following command will index the whole thing:

 ant jar-complete && java -classpath ./dist/jython.jar org.python.indexer.demos.HtmlDemo ./CPythonLib ./CPythonLib
 

Constructor Summary

Constructors

Constructor and Description
HtmlDemo()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HtmlDemo

public HtmlDemo()

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception