跳转到主要内容

Doxygen / Sphinx 桥接,带自动文档和自动摘要

项目描述

https://travis-ci.org/rmcgibbo/sphinxcontrib-autodoc_doxygen.svg?branch=master

示例输出

这是一个(spre-alpha)为sphinx编写的扩展,用于读取和显示Doxygen XML输出。它与Breathe类似。实现尽可能接近地扩展了sphinx.ext.autodocsphinx.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

这将在这里显示输出

安装

您可以使用pip(py27或py33+)来安装它。

pip install sphinxcontrib-autodoc_doxygen

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

如果您使用的是Anaconda Python发行版,请运行conda install lxml。在Linux的系统包管理器上,sudo apt-get install python-lxmlsudo 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,它将被缓存,所以即使切换虚拟环境也只需要这样做一次。

项目详情


下载文件

下载适合您平台的文件。如果您不确定该选择哪个,请了解更多关于安装包的信息。

源分发

sphinxcontrib-autodoc_doxygen-0.7.0.tar.gz (254.1 kB 查看哈希值)

上传时间

构建分发

sphinxcontrib_autodoc_doxygen-0.7.0-py2.py3-none-any.whl (15.8 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下机构支持

AWSAWS 云计算和安全赞助商 DatadogDatadog 监控 FastlyFastly CDN GoogleGoogle 下载分析 MicrosoftMicrosoft PSF 赞助商 PingdomPingdom 监控 SentrySentry 错误日志 StatusPageStatusPage 状态页面