TexDoc Class Reference
Formatter class for text documentation.
More...
List of all members.
|
Public Member Functions |
| def | bold |
| | Format a string in bold by overstriking.
|
| def | italic |
| | Format a string in bold by overstriking.
|
| def | texttt |
| def | classdesc |
| def | funcdesc |
| def | itemize |
| def | indent |
| | Indent text by prepending a given prefix to each line.
|
| def | section |
| | Format a section with a given heading.
|
| def | paragraph |
| | Format a section with a given heading.
|
| def | formattree |
| | Render in text a class tree as returned by inspect.getclasstree().
|
| def | docmodule |
| | Produce text documentation for a given module object.
|
| def | docclass |
| | Produce tex documentation for a given class object.
|
| def | formatvalue |
| | Format an argument default value as text.
|
| def | docroutine |
| | Produce text documentation for a function or method object.
|
| def | docproperty |
| | Produce text documentation for a property.
|
| def | docother |
| | Produce text documentation for a data object.
|
Public Attributes |
| | needone |
Static Public Attributes |
| | repr = _repr_instance.repr |
Detailed Description
Formatter class for text documentation.
Definition at line 36 of file texDoc.py.
Member Function Documentation
Format a string in bold by overstriking.
Definition at line 45 of file texDoc.py.
| def italic |
( |
|
self, |
|
|
|
text | |
|
) |
| | |
Format a string in bold by overstriking.
Definition at line 50 of file texDoc.py.
| def texttt |
( |
|
self, |
|
|
|
text | |
|
) |
| | |
| def classdesc |
( |
|
self, |
|
|
|
classname, |
|
|
|
text | |
|
) |
| | |
| def funcdesc |
( |
|
self, |
|
|
|
name, |
|
|
|
parameters, |
|
|
|
text | |
|
) |
| | |
| def itemize |
( |
|
self, |
|
|
|
List | |
|
) |
| | |
| def indent |
( |
|
self, |
|
|
|
text, |
|
|
|
prefix = ' ' | |
|
) |
| | |
Indent text by prepending a given prefix to each line.
Definition at line 91 of file texDoc.py.
| def section |
( |
|
self, |
|
|
|
title, |
|
|
|
contents | |
|
) |
| | |
Format a section with a given heading.
Definition at line 100 of file texDoc.py.
| def paragraph |
( |
|
self, |
|
|
|
title, |
|
|
|
contents | |
|
) |
| | |
Format a section with a given heading.
Definition at line 105 of file texDoc.py.
| def formattree |
( |
|
self, |
|
|
|
tree, |
|
|
|
modname, |
|
|
|
parent = None, |
|
|
|
prefix = '' | |
|
) |
| | |
Render in text a class tree as returned by inspect.getclasstree().
Definition at line 112 of file texDoc.py.
| def docmodule |
( |
|
self, |
|
|
|
object, |
|
|
|
name = None, |
|
|
|
mod = None | |
|
) |
| | |
Produce text documentation for a given module object.
Definition at line 129 of file texDoc.py.
| def docclass |
( |
|
self, |
|
|
|
object, |
|
|
|
name = None, |
|
|
|
mod = None | |
|
) |
| | |
Produce tex documentation for a given class object.
Definition at line 215 of file texDoc.py.
| def formatvalue |
( |
|
self, |
|
|
|
object | |
|
) |
| | |
Format an argument default value as text.
Definition at line 335 of file texDoc.py.
| def docroutine |
( |
|
self, |
|
|
|
object, |
|
|
|
name = None, |
|
|
|
mod = None, |
|
|
|
cl = None | |
|
) |
| | |
Produce text documentation for a function or method object.
Definition at line 340 of file texDoc.py.
| def docproperty |
( |
|
self, |
|
|
|
object, |
|
|
|
name = None, |
|
|
|
mod = None, |
|
|
|
cl = None | |
|
) |
| | |
Produce text documentation for a property.
Definition at line 411 of file texDoc.py.
| def docother |
( |
|
self, |
|
|
|
object, |
|
|
|
name = None, |
|
|
|
mod = None, |
|
|
|
maxlen = None, |
|
|
|
doc = None | |
|
) |
| | |
Produce text documentation for a data object.
Definition at line 416 of file texDoc.py.
Member Data Documentation
repr = _repr_instance.repr [static] |
The documentation for this class was generated from the following file:
- /Users/sean/workspace/SLIMpy3/slimpy_base/utils/texDoc.py
