Te4nick

apidocgen

Apr 21st, 2023
724
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
Python 0.83 KB | None | 0 0
  1. import inspect
  2.  
  3. def generate_doc(module_name):
  4.     """
  5.    Генерирует документацию на модуль в формате Markdown.
  6.  
  7.    :param module_name: Имя модуля, для которого необходимо сгенерировать документацию.
  8.    """
  9.     module = __import__(module_name)
  10.     file_name = module.__file__
  11.     functions = inspect.getmembers(module, inspect.isfunction)
  12.  
  13.     markdown = f"# Документация на модуль {module_name}\n\n"
  14.     markdown += f"Файл: `{file_name}`\n\n"
  15.  
  16.     for name, func in functions:
  17.         args = inspect.signature(func).parameters.values()
  18.         args_list = ", ".join([arg.name for arg in args])
  19.  
  20.         markdown += f"## `{name}({args_list})`\n\n"
  21.         markdown += f"{func.__doc__}\n\n"
  22.  
  23.     return markdown
Advertisement
Add Comment
Please, Sign In to add comment