文档生成器sphinx和mkdocs

https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html

https://docs.readthedocs.io/en/stable/intro/getting-started-with-mkdocs.html

文档生成器其实是属于静态网站程序。

------

MkDocs vs Sphinx

尤其是Sphinx工具，最近学习了另外一个文档生成工具MkDocs，更加符合个人的需求

Sphinx问题

Sphinx是一个文档生成工具，提供了方便快捷的文档生成操作，默认支持reStructuredText

虽然也能够使用Markdown，但是在实际操作过程中，发现若干问题：

1. 不能有效设置数学公式渲染
2. 不支持Markdown表格

MkDocs解析

MkDocs同样是一个简单、易用的文档生成工具，其默认支持Markdown，能够使用表格语法，同时通过扩展能够解决数学公式渲染的问题

同时相比于Sphinx，其配置更加简洁易懂，降低使用门槛

小结

替换掉Sphinx，当前的文档操作流程是

mkdocs文档制作，github远程托管，readthedocs在线发布.