Add API reference to documentation

polsys / ennemi

Easy Nearest Neighbor Estimation of Mutual Information

https://polsys.github.io/ennemi/

MIT License

35 stars 12 forks source link

Add API reference to documentation #43

Closed polsys closed 4 years ago

polsys commented 4 years ago

Not necessarily generated from docstrings, but something like that.

polsys commented 4 years ago

While doing this, it is worth updating the Potential issues document to mention estimate_entropy and its non-issues.

polsys commented 4 years ago

...and tweak the GitHub Pages theme a bit. At least on my computer, the text body is too narrow in the case study. The case study could also be rerun with transparent=True in the figures.