Sphinx 1.1¶

发布 1.1.3 (2012年3月10日)¶

PR#40: 修复 safe_repr 函数，使其能够正确解码包含非ASCII字符的字节字符串。
PR#37: 允许通过 SPHINX_APIDOC_OPTIONS 配置 sphinx-apidoc。
PR#34: 恢复 Python 2.4 兼容性。
PR#36: 使 LaTeX 输出中“参考文献到目录”的修复特定于文档类。
#695: 当明确指定高亮语言为“python”时，不要尝试解析代码以识别非Python片段。
#859: 修复在某些情况下找不到合适的链接对象时发生的异常。
#860: 遇到无效的 doctest 示例时不要崩溃，只发出警告。
#864: 修复在某些 modindex_common_prefix 设置下发生的崩溃。
#862: 修复 Python 3 上 -D 和 -A 选项的处理。
#851: 识别并警告循环的 toctree，而不是陷入递归错误。
#853: 恢复与 Docutils 主干的兼容性。
#852: 再次修复 HtmlHelp 索引条目链接。
#854: 修复 inheritance_diagram 在内置类型上引发属性错误的问题。
#832: 修复在词汇表中放置注释或孤立术语时发生的崩溃。
#834, #818: 修复所有 Sphinx 支持语言的 HTML 帮助语言/编码映射。
#844: 修复 doctest 扩展中处理 Unicode 输出时发生的崩溃。
#831: 按照宣传在 setup_command 中提供 --project 标志。
#875: 修复 Python 3 下读取配置文件的问题。
#876: 修复 Python 3 下快速启动测试的问题。
#870: 修复删除文档时出现的虚假 KeyError。
#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 和 HtmlHelp 索引条目链接。
#792: 在源分发中包含“sphinx-apidoc”。
#797: 不要在格式错误的词汇表上崩溃。
#801: 使 intersphinx 在没有 SSL 支持的情况下也能正常工作。
#805: 使 Sphinx.add_index_to_domain 方法正常工作。
#780: 修复 Python 2.5 兼容性。

发布 1.1 (2011年10月9日)¶

不兼容的变更¶

py:module 指令不再输出其 platform 选项值。（这是该指令唯一输出的内容，因此很不一致。）
删除了对旧依赖版本支持；现在要求
- Pygments >= 1.2
- Docutils >= 0.7
- Jinja2 >= 2.3

新增功能¶

添加了 Python 3.x 支持。
新的构建器和子系统
- 添加了 Texinfo 构建器。
- 添加了内容 i18n 支持、gettext 构建器和相关实用程序。
- 添加了 websupport 库和构建器。
- #98: 添加了一个 sphinx-apidoc 脚本，可自动生成包含 autodoc 指令的源文件层次结构，用于文档模块和包。
- #273: 添加了一个 API，用于为英语以外的语言添加全文搜索支持。添加了对日语的支持。
标记
- #138: 添加了 index 角色，用于创建内联索引条目。
- #454: 添加了更多索引标记功能：标记查看/参阅条目，以及给定键的主要条目。
- #460: 允许使用 toctree 的 numbered 选项限制 HTML 部分编号的深度。
- #586: 实现了改进的 glossary 标记，允许每个定义有多个术语。
- #478: 添加了 py:decorator 指令来描述装饰器。
- C++ 域现在支持数组定义。
- C++ 域现在支持文档字段（指令内的 :param x:）。
- only 指令中的章节标题现在已正确处理。
- 为源代码指令添加了 emphasize-lines 选项。
- #678: C++ 域现在支持超类。
HTML 构建器
- 添加了 pyramid 主题。
- #559: html_add_permalinks 现在是一个字符串，用于指定永久链接中显示的文本。
- #259: HTML 表格行现在具有偶数/奇数 CSS 类，以实现“斑马线样式”。
- #554: 为基本主题添加了主题选项 sidebarwidth。
其他构建器
- #516: 添加了 latex_show_urls 选项的新值，以在脚注中显示 URL。
- #209: 添加了 text_newlines 和 text_sectionchars 配置值。
- 添加了 man_show_urls 配置值。
- #472: linkcheck 构建器：并行检查链接，使用 HTTP HEAD 请求并允许配置超时。新的配置值：linkcheck_timeout 和 linkcheck_workers。
- #521: 添加了 linkcheck_ignore 配置值。
- #28: LaTeX 构建器中支持表格的行/列跨越。
配置和可扩展性
- #537: 添加了 nitpick_ignore。
- #306: 添加了 env-get-outdated 事件。
- Application.add_stylesheet() 现在接受完整的 URI。
Autodoc
- #564: 添加 autodoc_docstring_signature。启用此选项（默认）后，如果文档字符串的第一行中找到签名，autodoc 会从中检索签名。
- #176: 为 autodoc 指令提供 private-members 选项。
- #520: 为 autodoc 指令提供 special-members 选项。
- #431: 属性的文档注释现在可以与赋值在同一行给出。
- #437: autodoc 现在显示类数据属性的值。
- autodoc 现在支持文档 functools.partial 对象的签名。
其他扩展
- 添加了 sphinx.ext.mathjax 扩展。
- #443: 允许引用外部 graphviz 文件。
- 为 graphviz 指令添加了 inline 选项，并修复了 LaTeX 输出中的默认（块级）样式。
- #590: 为 graphviz 指令添加了 caption 选项。
- #553: 在 doctest 扩展中添加了 testcleanup 块。
- #594: trim_doctest_flags 现在也移除了 <BLANKLINE> 指示符。
- #367: 添加了继承图中隐藏成员的自动排除，以及选择性启用它的选项。
- 添加了 pngmath_add_tooltips。
- 数学扩展的 displaymath 指令现在支持 name 和 label 来给出方程标签，以兼容 Docutils。
新的语言环境
- #221: 添加了瑞典语语言环境。
- #526: 添加了伊朗语言环境。
- #694: 添加了拉脱维亚语语言环境。
- 添加了尼泊尔语语言环境。
- #714: 添加了韩语语言环境。
- #766: 添加了爱沙尼亚语语言环境。
修复的 Bug
- #778: 修复搜索结果链接页面上的“隐藏搜索匹配”链接。
- 修复“viewcode”扩展引用的源代码位置。