module_doc.py

class ModuleDoc():
    """Represents markdown document on the module level."""

    def __init__(self, namespace, description=''):
        self.namespace = namespace
        self.methods = {}
        self.description = description

    def build(self):
        """Creates a representation of a module in Markdown format.
        Note that methods, are ordered alphabetically."""

        output = ('# ' + self.namespace + ' module\n\n')
        if (self.description != ''):
            output = ('# ' + self.namespace + ' module\n\n' +
                      self.description + '\n\n')

        if len(self.methods) > 0:
            output += ('# Methods\n\n'
                       '|Name|Description|\n'
                       '|---|---|\n')

            for name in sorted(self.methods.keys()):
                # No args defined for this method.
                if self.methods[name][0] == '':
                    args = ''
                else:
                    args = self.__format_args(
                        list(self.methods[name][0].values()))

                desc = self.methods[name][1]
                output += f'|[{name} ({args})](./{name}.md)|{desc}|\n'

        return output

    def __format_args(self, args):
        if isinstance(args, list):
            return ', '.join(args)
        else:
            return args

    def addMethod(self, name, args, desc=''):
        self.methods.update({name: [args, desc]})