Exhale(Doxygen+Breathe+Sphinx)为C++创建优雅文档

  1. 首先要安装好Doxygen和Sphinx和exhale
    1. Brew install doxygen
    2. Pip install sphinx
    3. Pip install exhale (breathe会被默认安装)
  2. 在项目文件下面建立doc文件夹
  3. 配置Doxygen
    1. Doxygen -g Doxyfile 生成doxyfile配置文件
    2. 在其中添加一些自己想要的更改
  4. 配置Sphinx
    1. Sphinx-quickstart 生成项目模版
    2. 按照https://exhale.readthedocs.io/en/latest/quickstart.html所述王模版中添加exhale和breathe插件
    3. 同上链接修改sphinx主题
  5. 编译:make html即可产生网页文档

Sphinx拓展

  1. Myst-parser 拓展
    1. 启动: Syntax Extensions
    2. 说明: Markdown-It-Py Plugin Extensions — mdit-py-plugins

Reference:

  1. Quickstart Guide — Exhale: Automatic C++ Library API Generation
  2. Quickstart Guide — Exhale: Automatic C++ Library API Generation
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值