yuki-koyama / mathtoolbox

Mathematical tools (interpolation, dimensionality reduction, optimization, etc.) written in C++11 with Eigen
https://yuki-koyama.github.io/mathtoolbox/
MIT License
257 stars 35 forks source link

[Discussion] Document template (readthedocs?) #31

Closed yuki-koyama closed 6 years ago

yuki-koyama commented 6 years ago

Recently, readthedocs https://readthedocs.org/ has become more and more popular. Should we use it?

Pros:

Cons:

As an alternative choice, MkDocs https://www.mkdocs.org/ may be worth investigating, which allows us to use Markdown.

yuki-koyama commented 6 years ago

By using sphinx_rtd_theme, the issue #19 can be resolved.

yuki-koyama commented 6 years ago

libigl also uses MkDocs for documentation: http://libigl.github.io/libigl/

yuki-koyama commented 6 years ago

I changed the way of managing the document.