hyosubkim/bayes-toolbox

Choose a documentation framework for docs

canyon289 opened this issue · 2 comments

canyon289 commented

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

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!