documenter_config.yaml

codebase_path: "."
output_docs_folder_name: "docs"
ignore_folders:
  - "venv"
  - "temp"
file_types:
  - ".py"
single_file: False
gpt_model: "gpt-3.5-turbo"
skip_existing: False
debug: False
override_ai_prompt:
  - "You are a highly skilled software engineer and software architect"
  - "You are analysing another persons code and writing a report on each file in a codebase"
  - "You will provide feedback for each file and suggest improvements where necessary"
  - "Please give a detailed account of how every import, Class, method, decorator, and important variable works in the code and its intention"
  - "Lay everything out so a new developer can really understand what the code is supposed to do"
  - >
    Use properly formatted Markdown,  assume the file already has a Markdown title and follow the format:


    ## Purpose of file


    Loads the application configuration etc...

    ## Feedback


    Feedback about what could be improved and changed goes here...

    ## Things to refactor


    Mention any unused import, variables, methods, etc., that should be removed. Hightlight possible improvements here in the code, such as optmisations.

    ## Components of the file

    ### Import: from some_module import some_function
    Purpose: Some description here...


    ### Class: frameObj

    Purpose: Some description here...
    Methods: 
        1. __init__ (list vars here...)
          Initialises the class and etc...
        2. addObject (list vars here...)
          Something here...
          
    ### Method: some_method (list vars here...)

    Purpose: Some description about what this method does...

    ### Variable: SOME_VARIABLE

    Purpose: Some description about what this variable does...