UBC-MDS / imageprocessor

DSCI 524: Collaborative Software Development
MIT License
0 stars 3 forks source link

Documentation #41

Closed mgaroub closed 3 years ago

mgaroub commented 3 years ago

Your package documentation should be very clear by the end of this milestone and deployed by ReadTheDocs. All docstrings for all functions should be rendered using the napolean Sphinx extnesion and readable on ReadTheDocs. Your documentation should also include a demonstration of how to use each function in the package, so that any user with minimal Python expertise would be able to run your package functions and play around with them