通过Eigen使用sphinx生成c++文档)

1. 系统环境：win10+CMake+Doxygen+Sphinx+Breathe+Eigen+python

2. C++标准的文档系统是Doxygen，Sphinx主要用来生成python文档。倘若要用Sphinx去生成c++标准文档，需要Breathe与Eigen进行转化。
   
   上图给出Eigen的版本冲突。以下给出相关文档，有意者可查阅。
   Doxygen官方文档
   Sphinx官方文档
   Breathe官方文档
   Eigen官方文档

3. Doxygen安装与简单使用，详情可查看链接：https://www.cnblogs.com/gentletk/p/16536564.html，双击doxygen.exe进行安装，安装完即可。

4. 安装Sphinx+Breathe+Eigen。
   三者皆可以用pip进行安装，前提需要安装python与pip。
   pip install exhale
   pip install sphinx
   pip install breathe

5. 安装安成后，通过sphinx-quickstart命令快速生成conf.py 和 index.rst 文件模板。此命令建议在docs文件运行，生成过程需要填写一些信息。最后生成的文件包括docs下的source子文件夹、make.bat、Makefile，以及source文件夹下最重要的conf.py文件与index.rst文件。conf.py是Sphinx的配置文件，里面需要包括插件配置以及其他参数的设置。因为需要Exhale帮助转化sphinx,需要在conf.py中注入Exhale。其配置方法如下图所示，详细信息请查看文档。在配置文件中，最重要的参数为"exhaleDoxygenStdin" 中的INPUT参数，简单来讲，你想生成那个模块的文档，这里要填这个模块的相对路径。
   
   经此操作，既可以调用doxygen进行文档生成了，但还是但是还需要让他在页面上显示出来。这就需要在index.rst中添加exhale_args对象中定义的rootFile。如下图中的api/library_root。注意的是这些文件必须放在toctree指令下面，并且不能和上面冒号所表示的选项相连，要空一行。
   
   最后在docs目录下运行make html 即可生成html文档，这是运行之后的文档目录。
   

   最后将红色箭头所指向的index.html用浏览器打开即可。
   
   本文章只展示了最基础的一些操作，具体功能还需要再开发。

备注：如果只想使用doxygen生成c++文档，doxygen安装完成后要进行配置。配置方式分为两种，第一种为打开开始-》所有程序-》Doxygen-》doxywizard使用ui界面进行配置；第二种是使用文件方式进行配置，其中终目的都是生成Doxyfile。本文以第二种方式为例。

本文所用项目目录结构如下图所示：

对于一个新的项目，通过 doxygen -g 生成一个 doxyfile 文件的模板，这个模板很长，并且需要自己配置。

最后运行 doxygen Doxyfile 即可。