Add documentation for the project #5
Description
Write an organized README and potentially other documents detailing information about the project.
- What is the project?
- What's the purpose? Why the project was created?
- The tools and concepts used to build the project
- Skills and tools learned along the way
- Define the different components of the project
- Document the API (the abstract classes)
- Document the library (The implementations)
- Discuss how to set up and use the application
Look into automatically generating documentation from the code annotations.
https://www.google.com/search?q=automatic+documentation+from+python+docstring&oq=automatic+documentation+from+python+docstring&aqs=chrome..69i57.11546j0j4&sourceid=chrome&ie=UTF-8
https://stackoverflow.com/questions/5334531/using-javadoc-for-python-documentation
https://medium.com/blueriders/python-autogenerated-documentation-3-tools-that-will-help-document-your-project-c6d7623814ef