readme

Init autodocker module

Functions

def all_project_types() -> list[str]:

Returns all project types


def generate(
   project_path: str,
   config: dict[str, Type[ABCFileType]] = None,
   ignore_list: list[str] = None,
   document_type: str = 'py',
   extend: list[str] = None,
   output: str = 'docs'
) -> Iterable[tuple[int, int]]:

Runs filetypes

  • project_path - path to the project
  • config - config dictionary
  • ignore_list - list of file extensions that need to ignore
  • document_type - project document type
  • extend - list of file extensions that need to include
  • output - output directory