Docsy_tools

Objects

DocsyTools()
DocsyTools.write_class_to_markdown()
DocsyTools._method_to_str()
DocsyTools._get_list_of_methods()

A class to help with writting markdown.

DocsyTools()

class DocsyTools():

DocsyTools Class

DocsyTools.write_class_to_markdown()

@classmethod
def DocsyTools.write_class_to_markdown(cls, class_to_write, fn_out, method_to_omit=unknown, omit_private_methods=True, omit_parent_methods=True):

None

DocsyTools._method_to_str()

@classmethod
def DocsyTools._method_to_str(cls, method_name):

None

DocsyTools._get_list_of_methods()

@classmethod
def DocsyTools._get_list_of_methods(cls, class_to_search, methods_to_omit=unknown, omit_private_methods=True, omit_parent_methods=True):

Method get a list of methods inside a provided COAsT class, with some other options.

Args:
                class_to_search (Type): Class imported from COAsT (e.g. from coast import Profile)
                methods_to_omit (List): List of method strings to omit from the output. The default is [].
                omit_private_methods (bool): If true, omit methods beginning with "_". The default is True.
                omit_parent_methods (bool): If true, omit methods in any parent/ancestor class. The default is True.

Returns:
                List[str]: List of strings denoting method names.