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无法更新Maven配置   Java中错误和异常的区别?   java从日期开始获得小时、分钟和秒?   使用jsonpath使用数组索引进行java解析   java如何从改造中读取json响应   Java:封装概念   Scala的java Play Framework:[类型控制器不是包控制器的成员]   java JPA Hibernate使用criteria builder生成的左连接被忽略   使用mvn测试版本号时,java Maven无法解析依赖项   java安卓的vitals和异常处理   java组织。springframework。网状物绑定参数的MissingServletRequestParameterException   java JSON解析在Android应用程序脱机时崩溃   java如何降低SmartMaterialSpinner的高度?   java有一种在使用矩阵时不拉伸位图的方法。位图上的polytoply()?   java arraylist有问题吗   java调用dispose()不会关闭JFrame   java主机环境安全   java是否产生/加入释放监视器锁?   java包含json文件并将其读入生成的maven中。jar文件