Method generate_function_wikidocs

scripts/api_doc_generator.py:169–209

(self, func_string, func, is_class = False)

            pass

    def generate_function_wikidocs(self, func_string, func, is_class = False):
        directive = '----\n\n.. function' if not is_class else '   .. method'
        res = '\n{0}:: {1}('.format(directive, func_string)
        argspec = inspect.getargspec(func)
        args = argspec[0]
        defaults = argspec[3]
        def_values = []

        # Get the arguments
        for n in range(0, len(args)):
            try:
                if defaults != None and len(defaults) >= len(args) - n:
                    res += '{0}={1}, '.format(args[n], defaults[n - (len(args) - len(defaults))])

                    def_values.append((args[n], defaults[n - (len(args) - len(defaults))]))
                else:
                    res += '{0}, '.format(args[n])
            except:
                res += '{0}, '.format(args[n])
        if res[-1] != '(':
            res = res[:-2]
        res += ')\n\n'

        # Add docstring
        if func.__doc__ != None:
            # Remove indentation
            doc = inspect.cleandoc(func.__doc__)
            seen_code = False

            # Add wiki syntax for code
            l = []
            for line in doc.splitlines():
                if line.startswith('>>>') and not seen_code:
                    l.append('\n      ' + line)
                    seen_code = True
                else:
                    l.append(line)
            doc = '\n      '.join(l)

            res += '      {0}\n\n'.format(doc)
        return res

    def reset(self):
        self.functions = []