New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for the project #5

Open

8 tasks

Navnedia opened this issue Dec 10, 2022 · 0 comments

Assignees

Labels

Owner

Navnedia commented Dec 10, 2022 •

edited

Loading

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

Navnedia added documentation enhancement labels

Navnedia self-assigned this

Navnedia removed the enhancement label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment