(Copied from the course repo)
link to the repo: https://pages.github.ubc.ca/mds-2024-25/DSCI_524_collab-sw-dev_students/release/milestone3/milestone3.html

Write and publish the package-level documentation
Your package-level documentation should be very clear and polished by the end of this milestone. It should include a vignette (i.e., an article/tutorial) demonstrating how to use all your package functions on a more real-life example than the examples in the function documentation. There should be clear and well written narrative to go along with the code examples in the vignette. Essentially, this documentations should enable any user with minimal expertise to be able to run your package functions and play around with them.

This documentation should be published to a website, using the tools most appropriate for the programming language you wrote your code in. For Python, all function documentation should be rendered using the napolean Sphinx extension and readable on ReadTheDocs. Your vignette should be a Jupyter notebook in the docs folder.

Here are some examples of good vignettes/tutorials:

https://altair-viz.github.io/case_studies/exploring-weather.html

https://matplotlib.org/stable/tutorials/images.html

https://pandas.pydata.org/docs/user_guide/groupby.html

Make sure you tell your users about the status of your docs and where they can view a rendered version! The easiest way to do this is to add the ReadtheDocs status button to your packages README.md file. You can find this under your project on ReadtheDocs by clicking the “i” icon beside the badge (see image below):