========== Documentation ================

Documentation to be created with "epydoc" and stored in TLib/doc in html format.

======= To create / update ======

1. Open command line terminal
2. Change directory to be in side the TLib repository
3. execute "epydoc.py --html tlib -o doc"

Documentation can be viewed by accessing TLib/doc/index.html

======== What is documented =======

The documentation is constructed from the comments in the source code files.  Classe and method
documentation is taken from any text placed within 6 double quotes (3 to open and 3 to close).  The 
double quotes need to appear directly under the definition line.

eg : 

class SomeClass(object):
	"""
	This is my class documentation
	"""

	def someMethod():
	"""
	This is my method documentation
	"""

Variables can also be documented by including a pound and colon after the definition.

eg:

myVariable = "This is a string"			#: This is my variable documentation 
