hyosubkim / bayes-toolbox

bayes-toolbox
https://hyosubkim.github.io/bayes-toolbox/
Other
93 stars 5 forks source link

Choose a documentation framework for docs #5

Closed canyon289 closed 1 year ago

canyon289 commented 1 year ago

Add a documentation framework. The two come to mind are mkdocs and sphinx. Sphinx is the most used but most heavy weight. Ive heard good things about mkdocs

https://www.sphinx-doc.org/en/master/ https://www.mkdocs.org/

hyosubkim commented 1 year ago

I used mkdocs to create this static site for BST: https://hyosubkim.github.io/bayesian-statistics-toolbox/. I basically copied over the content from the README.md to populate the site. Let me know what you think--thanks!

hyosubkim commented 1 year ago

Docs now live here: https://hyosubkim.github.io/bayes-toolbox/