Doxygen/Sphinx桥,带AutoDoc和AutoSummary

sphinxcontrib-autodoc_doxygen的Python项目详细描述


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

Example Output

这是sphinx的一个(pre-alpha)扩展,用于读取和显示doxygen xml输出。它类似于 呼吸。该实现将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

这将生成显示的输出here

安装

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

pip install sphinxcontrib-autodoc_doxygen

必需的依赖项应该由pip获取。如果你找不到lxml, 以下是一些提示:

如果使用Anacondapython 分发,运行conda install lxml。使用Linux上的系统包管理器, sudo apt-get install python-lxmlsudo 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。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何修复“无法解析:com”。安卓安卓 studio中的volly:volly:1.1.1'错误   如果必须将每个捆绑包导入另一个捆绑包,那么每个捆绑包都应该是服务吗?   java HttpURLConnection:getResponseMessage()、getInputStream()和getContent()之间的差异   java添加、删除和删除数组中的所有方法,而不使用任何其他数据结构或任何其他导入   java如何在Android应用程序中使用javaanpr?   java在设备控制字符上拆分字符串   java 安卓填充另一个类ArrayList   java当我尝试使用Google Cloud Vision时,我得到了无效的_参数   java无法通过Hibernate更新记录   如何单击“继续”按钮完成Selenium Java中的调查   quartz和mysql的java自动架构创建因MySQLSyntaxException而失败   java我在jsp页面中进行了编码,但下一页它给出了空值   使用类对象作为泛型类型的java   java JavaFX setCellValueFactory方法调用更多次   java编写与pojo/entity/class等效的graphql模式   java使用多线程交替打印   分析考试结果限制(Java)   java如何使用SpringWebClient从并行web请求中收集结果?   Springboot如何在JavaSpringBoot中创建列表?