Doxygen/Sphinx桥,带AutoDoc和AutoSummary
sphinxcontrib-autodoc_doxygen的Python项目详细描述
这是sphinx的一个(pre-alpha)扩展,用于读取和显示doxygen xml输出。它类似于 呼吸。该实现将sphinx.ext.autodoc和sphinx.ext.autosummary扩展得与 有可能。
用法
在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
这将生成显示的输出here
安装
您可以使用pip(py27或py33+)安装它:
pip install sphinxcontrib-autodoc_doxygen
必需的依赖项应该由pip获取。如果你找不到lxml, 以下是一些提示:
如果使用Anacondapython 分发,运行conda install lxml。使用Linux上的系统包管理器, sudo apt-get install python-lxml或sudo yum install python-lxml应该起作用。 在windows上,您可以从Christoph Gohlke’s repository下载lxml。在OSX上,尝试以下长命令 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分钟),但一旦车轮建成,它将是缓存,所以您只需要 这样做一次,即使切换virtualenvs。