Documentation Generator
Opened this issue · 0 comments
thyecust commented
Documentation Generator
当我们谈论文档生成器的时候，其实有两类工具，一类是从代码生成文档（也可叫做 API 文档生成器？比如 Javadoc、doxygen、JsDoc、YARD、sandcastle、Rustdoc），一类是从文档生成文档。
第一类可以阅读 Wikipedia 的 Comparison of documentation generators。
附录：一些项目及其使用的文档生成器
| Project | Desc. | URL | D.G. |
|---|---|---|---|
| Flask | Web dev. | https://flask.palletsprojects.com/en/2.0.x/ | Sphinx 4.4.0 |
| FastAPI | Web API dev. | https://fastapi.tiangolo.com/ | Mkdocs-Material |
| Python | P.L. | https://docs.python.org/3/ | Sphinx 3.2.1 |
| Travis CI | CI | https://docs.travis-ci.com/api/ | Slate |
| Linux Mint | Linux | https://linuxmint-installation-guide.readthedocs.io/en/latest/ | Readthedocs (Sphinx) |
| ESP32 | IoT | https://docs.espressif.com/projects/esp-idf/en/latest/esp32/ | Readthedocs (Sphinx) |