sphinxcontrib-autodoc-doxygen 0.7.0

使用方法

在您的Sphinx conf.py中，将'sphinxcontrib.autodoc_doxygen'添加到扩展列表中，并将变量doxygen_xml设置为包含您的Doxygen XML输出的目录路径的字符串。

这将添加以下RST指令。

autodoxysummary
autodoxyclass
autodoxymethod
autodoxyenum

示例

.. autodoxysummary::
   :toctree: generated/
   :template: doxyclass.rst

   OpenMM::CustomIntegrator
   OpenMM::CustomCompoundBondForce

这将在这里显示输出

安装

您可以使用pip（py27或py33+）来安装它。

pip install sphinxcontrib-autodoc_doxygen

必要的依赖项应通过pip获取。如果您在获取lxml时遇到问题，这里有一些提示

如果您使用的是Anaconda Python发行版，请运行conda install lxml。在Linux的系统包管理器上，sudo apt-get install python-lxml或sudo yum install python-lxml应该可以解决问题。在Windows上，您可以从Christoph Gohlke的仓库下载lxml。在OS X上，尝试以下长命令brew install libxslt libxml2; LDFLAGS="-L/usr/local/opt/libxslt/lib -L/usr/local/opt/libxml2/lib" CPPFLAGS="-I/usr/local/opt/libxml2/include -I/usr/local/opt/libxslt/include" pip install lxml。这可能需要很长时间（约5分钟），但一旦构建了wheel，它将被缓存，所以即使切换虚拟环境也只需要这样做一次。