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生成随机浮点,包括两个边界   java三层体系结构风格是如何工作的?一些简单的例子   多线程可以使用线程。在Java中,在循环中使用sleep(),以便定期执行某些操作?   读取循环上的java HibernateMysql异常   java使用带有Apache Ivy的自定义存储库,未找到解析程序   filenotfoundexception在读取时出现问题。Java中的txt文件   嵌入式tomcat 8.0.21中的java Spring websocket   java为什么我需要创建一个类的引用,然后创建一个B类的对象   java Splashscreen动画在Mac OS中更新时闪烁   JavaSpring3。名为“zoneManagerDelegate”的x Bean必须是[com.ms.adsp.delegate.sapi.zoneManagerDelegate]类型,但实际上是[$Proxy20]类型   java SQLite:没有这样的专栏;不明错误   java将JTable定位到JFrame中JPanel中的(x,y)位置   java在导入组织方面面临挑战。知道。xchart*   xml读取Java中的SVG元素并跳过某些包含文本的元素   java Spring Redis问题:Redis缓存中的GetAllCacheNames不能与RedisCacheManager一起使用   java Vertex Hazelcast:集群问题   java如何编辑osgi托管服务实现使用的属性文件?   java Android活动并行启动?   java AWS Lambda用于将excel转储到数据库中