DocWriter
A general writer class that writes a file based off a template and filling in object template specs
Properties and Methods
template: str
template_root: str
template_name: str
default_template_dir: str
example_root: str
outStream: type
load_template: method
get_identifier: method
param_template: str
__init__(self, obj, out_file, obj_name=None, parent_obj=None, template=None, root=None, ignore_paths=None):
obj
:Any
No description…
out_file
:Any
No description…
get_name(self):
@property
out(self):
write_string(self, txt):
template_params(self):
format(self, template=None):
write(self, template=None):
get_package_and_url(self):
@property
package_path(self):
@property
identifier(self):
load_examples(self):
format_item(self, item, item_level=0):
format_link(self, alt, link):
format_obj_link(self, spec):
format_inline_code(self, arg):
arg
:str
No description…
:returns
:_
No description…
format_code_block(self, arg):
arg
:str
No description…
:returns
:_
No description…
format_quote_block(self, arg):
arg
:str
No description…
:returns
:_
No description…
parse_doc(self, doc):
doc
:str
No description…
:returns
:_
No description…
Examples
Edit Examples or
Create New Examples
Edit Template or
Create New Template
Edit Docstrings