- 首先要安装好Doxygen和Sphinx和exhale
- Brew install doxygen
- Pip install sphinx
- Pip install exhale (breathe会被默认安装)
- 在项目文件下面建立doc文件夹
- 配置Doxygen
- Doxygen -g Doxyfile 生成doxyfile配置文件
- 在其中添加一些自己想要的更改
- 配置Sphinx
- Sphinx-quickstart 生成项目模版
- 按照https://exhale.readthedocs.io/en/latest/quickstart.html所述王模版中添加exhale和breathe插件
- 同上链接修改sphinx主题
- 编译:make html即可产生网页文档
Sphinx拓展
- Myst-parser 拓展
Reference:
本文介绍了如何安装并配置Doxygen、Sphinx和exhale工具,用于生成C++项目的自动API文档,包括设置配置文件、添加插件和定制Sphinx主题,以创建完整的HTML文档。



676

被折叠的 条评论
为什么被折叠?



