ColtAllen / btyd

Buy Till You Die and Customer Lifetime Value statistical models in Python.
https://btyd.readthedocs.io/
Apache License 2.0
114 stars 9 forks source link

Update and Test Documentation #37

Closed ColtAllen closed 2 years ago

ColtAllen commented 2 years ago

Many aspects of the current lifetimes documentation such as themes and the markdown converter have been deprecated, requiring a complete overhaul. Not many changes have been made to the markdown files apart from tweaking the code snippets to reflect the changes I've made to the API, as well as now hosting all images directly on the git repo. I've not yet decided if I want to continue rendering markdown files or go all-in on .rst.

The default themes in sphinx don't quite appeal to me, so I've option to give pydata-sphinx-theme a shot. However, it remains fairly experimental with new versions of sphinx and is hence untested. I'll need to merge this pull request to test if it renders properly on www.ReadTheDocs.org.