|
|
None
|
write(self,
directory=None)
Write the API documentation for the entire project to the given
directory. |
source code
|
|
|
_write(self,
write_func,
directory,
filename,
*args) |
source code
|
|
int
|
|
None
|
_mkdir(self,
directory)
If the given directory does not exist, then attempt to create it. |
source code
|
|
|
|
|
|
|
|
|
|
|
|
|
|
string
|
|
|
base_tree(self,
doc,
width=None,
linespec=None) |
source code
|
|
|
|
|
|
|
_base_tree_line(self,
doc,
width,
linespec) |
source code
|
|
|
|
|
|
|
write_func_list(self,
out,
heading,
doc,
value_type,
seclevel=1) |
source code
|
|
|
write_func_group(self,
out,
doc,
name,
var_docs,
grouped_inh_vars) |
source code
|
|
|
write_func_inheritance_list(self,
out,
doc,
listed_inh_vars) |
source code
|
|
|
|
|
|
|
|
|
|
|
write_var_list(self,
out,
heading,
doc,
value_type,
seclevel=1) |
source code
|
|
|
write_var_group(self,
out,
doc,
name,
var_docs,
grouped_inh_vars) |
source code
|
|
|
write_var_inheritance_list(self,
out,
doc,
listed_inh_vars) |
source code
|
|
|
|
|
write_property_list_line(self,
out,
var_doc) |
source code
|
|
|
|
|
write_standard_field(self,
out,
doc,
field,
descrs,
arg='
' ) |
source code
|
|
|
_descrlist(self,
items,
singular,
plural=None,
short=0) |
source code
|
|
|
docstring_to_latex(self,
docstring,
indent=0,
breakany=0) |
source code
|
|
|
|
|
|
|
|
|
|
|
|
|
indexterm(self,
doc,
pos=' only ' )
Mark a term or section for inclusion in the index. |
source code
|
|
|
|
str
|
|