Package slimpy_base.utils.texDoc


Classes

class  TexDoc
 Formatter class for text documentation. More...

Functions

def getdoc
 Get the doc string or comments for an object.
def makeLatexSafe

Variables

string __copyright__
 latex documentation tool
string __license__
tuple latex = TexDoc()
list item = sys.argv[1]
list From = sys.argv[2]
tuple x = __import__( item, globals(), locals(), From )
tuple k = getattr( x, From )


Function Documentation

def slimpy_base.utils.texDoc.getdoc (   object  ) 

Get the doc string or comments for an object.

Definition at line 429 of file texDoc.py.

def slimpy_base.utils.texDoc.makeLatexSafe (   text  ) 

Definition at line 435 of file texDoc.py.


Variable Documentation

string __copyright__

Initial value:

"""
Copyright 2008 Sean Ross-Ross
"""
latex documentation tool

Definition at line 7 of file texDoc.py.

string __license__

Initial value:

"""
This file is part of SLIMpy .

SLIMpy is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

SLIMpy is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with SLIMpy . If not, see <http://www.gnu.org/licenses/>.
"""

Definition at line 10 of file texDoc.py.

list From = sys.argv[2]

Definition at line 454 of file texDoc.py.

list item = sys.argv[1]

Definition at line 453 of file texDoc.py.

tuple k = getattr( x, From )

Definition at line 458 of file texDoc.py.

tuple latex = TexDoc()

Definition at line 446 of file texDoc.py.

tuple x = __import__( item, globals(), locals(), From )

Definition at line 456 of file texDoc.py.


Generated on Sun Aug 10 09:11:12 2008 for SLIMpy by  doxygen 1.5.6