[Discussion] Document template (readthedocs?)
yuki-koyama opened this issue · comments
Recently, readthedocs https://readthedocs.org/ has become more and more popular. Should we use it?
Pros:
- Beautiful template (
sphinx_rtd_themehttps://sphinx-rtd-theme.readthedocs.io/) available
Cons:
- Need to learn
reStructuredTexthttp://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html and rewrite existing docs to it
As an alternative choice, MkDocs https://www.mkdocs.org/ may be worth investigating, which allows us to use Markdown.
By using sphinx_rtd_theme, the issue #19 can be resolved.
libigl also uses MkDocs for documentation: http://libigl.github.io/libigl/
I changed the way of managing the document.