This is the Source Code Documentation main page, you can find the table on contents above, which links the sub pages for each component of the source code. Each sub page contains detailed documentation and explanations of the respective component, along with code snippets and examples to help you understand how to use and implement it in your projects.

Each Sub Page is organized to tackle each file in the respective folder, and each file in sequential order based on the file name, each file will be explained in terms of how it works and why. The only file’s left out will be the __init__.py files, since they are just used to make the folder a package, and they don’t contain any code that needs to be explained. Any files that do not appear in the github such as .streamlit/ in the main folder, will be briefly explain where it needs to be.

When code in one file is heavily dependent on another, a reference to that page and section will be used to make life easier on the reader.

If any information is inaccurate to the code, or out of date, then it will most likely be updated at a later time, if a good amount of time has passed, then set a Github Issue, or last case scenario message me via email of LinkedIn.

Click on the respective section in the Table of Contents at the top of the page, to see a detailed documentation of the respective component of the source code, and if you have any questions or suggestions, feel free to reach out to me through my contact info in the footer.