|
|
__init__(self,
file='docstring.tex')
Fetch all the docstrings of the user functions and format them LaTeX
style. |
source code
|
|
|
|
doc_user_class(self,
parent_name,
parent_object)
Document the user class. |
source code
|
|
|
|
get_blacklist(self)
Maintained list of objects in the interpreter namespace which should
not be documented. |
source code
|
|
|
|
indexing(self,
index,
bold=0)
Function of inserting index marks into the text. |
source code
|
|
|
|
index_entries(self)
Function for returning a data structure containing all words which
should be indexed. |
source code
|
|
|
|
keywords(self)
Change the keyword label to bold sans serif font. |
source code
|
|
|
|
latex_formatting(self,
string)
Function for handling LaTeX maths environments. |
source code
|
|
|
|
latex_quotes(self,
string)
Function for changing the quotes for LaTeX processing. |
source code
|
|
|
|
latex_special_chars(self,
string)
Function for handling LaTeX special characters. |
source code
|
|
|
|
lists(self)
Function for creating LaTeX lists. |
source code
|
|
|
|
paragraph(self)
Function for extracting the paragraphs from the docstring. |
source code
|
|
|
|
parse_docstring(self,
function,
object)
Function for creating the LaTeX file. |
source code
|
|
|
|
quotes(self,
index)
Function for placing quotes within the quote environment. |
source code
|
|
|
|
relax_examples(self)
Use typewriter font for relax examples. |
source code
|
|
|
|
safe_replacement(self,
string,
text,
latex)
Only replace in safe places within the text. |
source code
|
|
|
|
tables(self)
Function for creating LaTeX tables. |
source code
|
|
|
|
verbatim(self)
Function for extracting the verbatim docstring section. |
source code
|
|