Sphinx1.1

版本1.1.3(2012年3月10日)

  • PR#40:修复 safe_repr 函数正确解码包含非ASCI字符的字节串。

  • PR#37:允许通过配置phinx-apidoc SPHINX_APIDOC_OPTIONS .

  • PR#34:恢复Python 2.4兼容性。

  • PR#36:在LaTeX输出中修复特定于文档类的“目录到目录”。

  • #695:当突出显示语言“python”被显式指定时,不要试图解析代码来识别非Python代码段。

  • #859:修复某些情况下找不到合适的对象要链接时的异常。

  • #860:遇到无效的docTest示例时不要崩溃,只需发出警告即可。

  • #864:使用的某些设置修复崩溃 modindex_common_prefix .

  • #862:修复处理 -D-A Python 3上的选项。

  • #851:识别并警告循环toctree,而不是遇到回归错误。

  • #853:恢复与Docutils主干的兼容性。

  • #852:再次修复htmlHelp索引条目链接。

  • #854:修复内建程序上引发的属性错误的继承_图。

  • #832:修复在术语表中添加评论或单独术语时崩溃的问题。

  • #834、#818:修复所有Sphinx支持的语言的HTML帮助语言/编码映射。

  • #844:修复在docTest扩展中处理Unicode输出时崩溃的问题。

  • #831:提供 --project 通知的select_命令中的标志。

  • #875:修复Python 3下读取配置文件的问题。

  • #876:修复Python 3下的快速启动测试。

  • #870:删除文档时修复虚假的KeyErrors。

  • #892:修复单HTML生成器在收件箱中使用主文档的不当行为。

  • #873:用空修复断言错误 only 指令。

  • #816:修复Qt帮助生成器中的编码问题。

版本1.1.2(2011年11月1日)--无论如何,1.1.1都是一个愚蠢的版本号!

  • #809:在源分发中包括自定义修复程序。

版本1.1.1(2011年11月1日)

  • #791:修复QtHelp、DevHelp和PtmlHelp索引条目链接。

  • #792:在源发行版中包含“phinx-apidoc”。

  • 第797章:你是我的女人

  • #801:让intersphinx在没有SSL支持的情况下正常工作。

  • #805:制作 Sphinx.add_index_to_domain 方法工作正确。

  • #780:修复Python 2.5兼容性。

Release 1.1(2011年10月9日)

不兼容的更改

  • py:module 指令不输出其 platform 期权价值不再了。 (It是该指令唯一输出的内容,因此非常不一致。)

  • 删除了对旧依赖项版本的支持;现在的要求是:

    • Pygents>= 1.2

    • 文档>= 0.7

    • Jinja2 >= 2.3

功能添加

  • Python 3.x支持

  • 新的构建器和子系统:

    • 添加了Texinfo构建器。

    • 添加了对内容的i18 n支持,a gettext 构建器和相关公用事业。

    • 添加了 websupport 图书馆和构建器。

    • #98:添加了 sphinx-apidoc 自动生成源文件层次结构的脚本,其中包含文档模块和包的autodoc指令。

    • #273:添加API,用于添加对英语以外语言的全文搜索支持。 添加对日语的支持。

  • 标记:

    • #138:添加了 index 角色,用于创建内联索引条目。

    • #454:添加了更多索引标记功能:标记参见/seealso条目以及给定键的主条目。

    • #460:允许使用限制HTML部分号的深度 toctree s numbered 选项.

    • #586:实施改进 glossary 标记,每个定义允许多个术语。

    • #478:添加 py:decorator 描述装饰师的指令。

    • C++域现在支持数组定义。

    • C++域现在支持文档字段 (:param x: 内部指令)。

    • 之标题 only 指令现在得到正确处理。

    • 添加 emphasize-lines 源代码指令的选项。

    • #678:C++域现在支持超类。

  • HTML构建器:

    • 添加 pyramid 主题.

    • #559: html_add_permalinks 现在是一个字符串,提供以永久链接显示的文本。

    • #259:HTML表行现在具有偶数/奇数CSS类来启用“Zebra样式”。

    • #554:添加主题选项 sidebarwidth 基本主题。

  • 其他构建器:

  • 配置和扩展性:

  • Autodoc:

    • #564:添加 autodoc_docstring_signature . 启用时(默认),autodoc将从文档字符串的第一行检索签名(如果在那里找到签名)。

    • #176:提供 private-members autodoc指令的选项。

    • #520:提供 special-members autodoc指令的选项。

    • #431:属性的文档注释现在可以与作业在同一行上给出。

    • #437:autodoc现在显示类数据属性的值。

    • autodoc现在支持记录的签名 functools.partial 对象

  • 其他扩展:

    • 添加了 sphinx.ext.mathjax 扩展名.

    • #443:允许引用外部graphviz文件。

    • 添加 inline graphviz指令的选项,并修复了LaTeX输出中的默认值(块风格)。

    • #590:添加 caption graphviz指令的选项。

    • #553:添加 testcleanup docTest扩展中的块。

    • #594: trim_doctest_flags 现在还删除了 <BLANKLINE> 指标

    • #367:添加了自动排除继承图中的隐藏成员,以及有选择地启用它的选项。

    • 添加 pngmath_add_tooltips .

    • 数学扩展显示数学指令现在支持 name 除了 label 用于给出方程标签,以便与Docutils兼容。

  • 新区域:

    • #221:添加了瑞典语言环境。

    • #526:添加了伊朗地区。

    • #694:添加了拉脱维亚地区。

    • 添加了尼泊尔地区。

    • #714:添加了韩国语言环境。

    • #766:添加了爱沙尼亚地区。

  • 已修复错误:

    • #778:修复通过搜索链接的页面上的“隐藏搜索匹配”链接。

    • 修复“viewcode”扩展引用的源位置。