TemplateHandler
template: NoneType
extension: str
squash_repeat_packages: bool
blacklist_packages: set
__init__(self, obj, *, out=None, engine: McUtils.Misc.TemplateEngine.TemplateEngine.TemplateEngine = None, root=None, squash_repeat_packages=True, **extra_fields):
template_params(self, **kwargs):
get_template_params(self, **kwargs):
Returns the parameters that should be inserted into the template
:returns
:dict
@property
package_path(self):
get_package_and_url(self, include_url_base=True):
Returns package name and corresponding URL for the object being documented
:returns
:_
@property
target_identifier(self):
get_target_extension(self, identifier=None):
get_output_file(self, out):
Returns package name and corresponding URL for the object being documented
:returns
:_
handle(self, template=None, target=None, write=True):
Formats the documentation Markdown from the supplied template
template
:Any
:returns
:_
check_should_write(self):
Determines whether the object really actually should be documented (quite permissive)
:returns
:_