Closed yuki-koyama closed 6 years ago
Recently, readthedocs https://readthedocs.org/ has become more and more popular. Should we use it?
readthedocs
Pros:
sphinx_rtd_theme
Cons:
reStructuredText
As an alternative choice, MkDocs https://www.mkdocs.org/ may be worth investigating, which allows us to use Markdown.
MkDocs
By using sphinx_rtd_theme, the issue #19 can be resolved.
libigl also uses MkDocs for documentation: http://libigl.github.io/libigl/
libigl
I changed the way of managing the document.
Recently,
readthedocs
https://readthedocs.org/ has become more and more popular. Should we use it?Pros:
sphinx_rtd_theme
https://sphinx-rtd-theme.readthedocs.io/) availableCons:
reStructuredText
http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html and rewrite existing docs to itAs an alternative choice,
MkDocs
https://www.mkdocs.org/ may be worth investigating, which allows us to use Markdown.