帮酷LOGO
  • 显示原文与译文双语对照的内容
文章标签:Restructuredtext  REST  bri  Bridge  dox  Doxygen  Sphinx  
Restructured text and Sphinx bridge to Doxygen

  • 源代码名称:breathe
  • 源代码网址:http://www.github.com/michaeljones/breathe
  • breathe源代码文档
  • breathe源代码下载
  • Git URL:
    git://www.github.com/michaeljones/breathe.git
  • Git Clone代码到本地:
    git clone http://www.github.com/michaeljones/breathe
  • Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/michaeljones/breathe
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
  • 呼吸

    这是reStructuredText和Sphinx的扩展,可以读取和呈现Doxygen输出。

    下载

    可以从github和 PyPI获得呼吸,python 包索引 。 它可以安装在:

    pip install breathe

    文档

    这里的文档是可用的,这里是 感谢运行的人们阅读文档这样的优秀服务。

    如果你想在本地构建文档并在本地阅读文档,那么就可以在 documentation 文件夹中。

    注释

    呼吸并不总是得到注意,但是我很热烈地想让它继续前进。 如果你报告一个问题,请一直提醒我,直到它被修正。 我应该更好,但是在静默的时候,我往往会移动到它的他的东西,然后再提醒我。

    测试

    testsuite可以通过以下方式运行:

    make dev-test

    文档还可以通过不同的示例来覆盖可用的功能。 若要生成文档,请运行:

    make

    这将在示例代码上运行 doxygen,然后运行Breathe文档。 查看以下结果:

    documentation/build/html/index.html

    另外,如果你想比较前面的文档输出,以便检查回归,在 documentation 文件夹中有一个 compare 脚本。 它接受两个参数,你希望比较两个提交引用。 这意味着你的所有更改都必须首先提交。 这个脚本不解析状态依赖引用( 如 HEAD ),所以提供具体的提交引用如SHA1s或者。 典型的示例是将当前分支输出与主输出进行比较:

    # Make sure all your changes are committed first
    cd documentation
    ./compare master my-branch

    这将在每次提交时进行签出和构建,然后针对结果目录运行 meld,这样你就可以看到分支引入的差异。

    要求

    目前的开发工作是:

    • python 2.7
    • Docutils 0.11
    • Sphinx 1.4
    • Doxygen 1.8.4

    Doxygen 1.5.1似乎产生了带有重复部分的xml,这导致了。 不确定什么时候解决这个问题,但最好是最好的选择。

    电子邮件列表

    Google网上论坛上有一个邮件列表:

    https://groups.google.com/forum/#!forum/sphinx-breathe

    以前的邮件列表位于 librelist.com,并且存档在这里是

    邮件列表比Github库更安静,所以在发布问题时可以自由发布问题。

    示例

    其他项目使用的呼吸示例:

    如果你有一个例子,你希望在这里列出,请制作一个github问题,详细信息。

    呼吸不是这个问题唯一的解决方法。 这些是我们所了解的。 如果你想在github问题中提供一个链接或者联系邮件列表,我们非常高兴列出它的他人。

    版本

    用于将源代码包&轮释放到PyPI的命令:

    python setup.py sdist bdist_wheel upload

    Credits

    呼吸由 michaeljones & vitaut维护,来自:

    感谢:

    更改日志

    Keepachangelog.com 激发。

    • 2017-10-09 Breathe呼吸 v4.7.3
      • 对cpp域中枚举的支持。
      • compoundref没有关联refid值的句柄情况。
    • 2017-08-15 Breathe呼吸 v4.7.2
      • 修复 python 2.7上带有轮子的封装问题。
    • 2017-08-13 Breathe呼吸 v4.7.1
      • 固定 Bug 关于代码段 inside Doxygen注释。
    • 2017-08-09 Breathe呼吸 v4.7.0
      • 用于防止文档和文件文档化的新outtypes选项
      • 指定是否应显示 MACROS 值的新布尔breathe_show_define_initializer选项。
      • New breathe_use_project_refids选项控制由呼吸生成的refids元素是否包含项目 NAME 或者。
      • 固定
        • 对 Sphinx 1.6的支持
    • 2017-02-25 Breathe呼吸 v4.6.0
      • 对接口指令的支持
      • 显示定义的内容
    • 2017-02-12 Breathe呼吸 v4.5.0
      • 改进c typedef处理
      • 支持新的desc_signature_line节点
      • 添加--project标志以呼吸 apidoc helper
      • 删除了 python 3.3的测试并添加了 3.6
    • 2016-11-13 Breathe呼吸 v4.4.0
      • 改进单行参数文档渲染
    • 2016-11-05 Breathe呼吸 v4.3.1
      • 版本bump与车轮释放的混淆
    • 2016-11-05 Breathe呼吸 v4.3.0
      • 使用访问者 Pattern 重写渲染方法
      • 放弃对 2.6 &的支持,增加了对 3.5的测试
      • 固定
        • 首次运行呼吸apidoc时出现问题。
        • 改进的限定符处理,例如。 常量 & volatile 。
        • 支持结构中的函数
        • 在 Windows 上支持自动doxygen代码路径
    • 2016-03-19 Breathe呼吸 v4.2.0
      • 添加
        • 输出到类'&子级children的输出链接。
        • sphinx配置选项的needs_extensions支持。
        • 呼吸apidoc脚本,使用来自 doxygen xml文件的呼吸指令生成ReStructuredText存根文件。
      • 固定
        • 在参数声明中处理默认值
        • 由于迭代过多,输出顺序无法重现。
        • 处理多个指针和引用
        • 严重:使用函数重载时出现重复的标识警告。
        • 使用默认项目时使用项目 NAME 链接引用。 所以我们使用 NAME 而不是'project0'。
    • 2015-08-27 Breathe呼吸 v4.1.0
      • 添加
        • 允许向自动指令使用的doxygen文件添加更多配置行的breathe_doxygen_config_options 配置变量。
      • 固定
        • 函数的array & array 参考参数的显示。
        • 使用模板参数处理到类的链接。
        • C 中未命名枚举的处理。
        • 模板参数部分的命名。
        • 查找组中的函数。
        • 模板的'typename'和'类'关键字的呈现。
    • 2015-04-02 Breathe呼吸 v4.0.0
      • 使用 miminal reStructureText接口更改对代码库进行了重要工作。 被记录。
    • 2014-11-09 Breathe呼吸 v3.2.0
      • 未添加,已经废弃或者已经删除
      • 固定
        • 修改了 docutils/sphinx节点使用以修复 LaTeX/pdf输出。
        • 检查路径分隔符检查 / 和 时,不管平台是什么。
        • 当设置默认项目配置设置时,使用 auto 指令而不指定 :project: 选项时的KeyError
        • 使用 doxygenfunction 不再会触发重复的目标检查,并且无法输出链接目标。
        • 在doxygen注释中支持 inline url 。
        • 函数参数中的array 表示法支持。
        • 通过更改 section-defs 以使用 container & rubric 节点而不是使用带有签名&内容的desc 节点。 像'。public 函数'这样的标题出现在 inline 中,它们的主题内容。
    • 2014-09-07 Breathe呼吸 v3.1.0
      • 不推荐或者删除的内容
      • 添加
        • doxygenclass 指令现在可以通过在参数名称中指定专门化来引用模板 specialisations 。
      • 固定
        • 显示Qt插槽输出的函数参数。 以前,虽然Qt插槽基本上只是函数,它们却丢失了。
        • 根据强调的文本显示doxygen注释中的标题。
        • 在生成关于无法找到定义。变量。enum 。typedef或者联合的警告时崩溃。
        • 仅在 declartion NAME 不可用时输出函数参数的定义 NAME 。 以前,他们两个都是可以用的,我们彼这里有两个名字,没有好的原因。
    • 2014-08-04 Breathe呼吸 v3.0.0
      • 改进 const 。volatile 。虚拟和纯虚拟关键字的输出。
      • 修复HTML类的输出,以便对象类型而不是名称作为css类输出。 '函数'而不是'myfunction'。
      • 修复呼吸问题:对出现在 header 和实现文件中的函数感到困惑。
      • 使用 doxygenfunction 指令时改进重载函数的匹配。 另外,在没有找到 MATCH 时提供潜在 MATCHES的列表。
      • 改进的:members: 实现以正确处理内部类。
      • 更新了 doxygenstruct 以共享 doxygenclass 实现路径,该路径将从 doxygenclass 指令中。
      • 添加了 :outline: 选项支持 doxygengroup & doxygennamespace 指令。
      • 添加了 doxygennamespace 指令。
      • doxygenclass & doxygengroup 指令添加 :undoc-members: 选项。
      • 分块中断更改: 删除 doxygenclass & doxygengroup 指令的:sections: 选项并将它的替换为 :members::protected-members::private-members:,并将 breathe_default_sections 配置变量更改为 breathe_default_members 。 这是为了更紧密地 MATCH autodoc功能和接口。
    • 2014-06-15 Breathe呼吸 v2.0.0
      • 为检查更改所引起的文档更改添加比较脚本。
      • 切换到 MathJax Javascript的https 参考。
      • 分为 Breaking Change Change: 更改指令以要求在 conf.py 中显式声明源文件,而不是试图从指令参数中检测它们。
      • switch 文档托管 ReadTheDocs.org.
      • 对所有的relative 路径进行收费:switch 假设所有的路径都是包含 conf.py 文件的目录。 以前,它假定它们是用户工作目录当前的relative 。 这将中断使用独立的生成&源目录的项目。
      • 添加 doxygenunion 指令。
      • 添加 doxygengroup 指令。
      • 在输出中添加对列表的支持。 他们以前被忽略。
      • 更新了使用Sphinx在可能时使用的docutils节点的实现。
    • 呼吸 v1.2.0
      • 更改日志未记录。


    文章标签:REST  bri  Bridge  Sphinx  dox  Restructuredtext  Doxygen  

    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语