UBC-MDS / nameforme

NameForMe - A python package to help suggest baby names.
MIT License
3 stars 3 forks source link

Document Package Using ReadTheDocs #62

Closed DanielCairns closed 1 year ago

DanielCairns commented 1 year ago

All docstrings for all functions should be rendered using the napolean Sphinx extension and readable on ReadTheDocs.

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.