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: 识别并警告循环 toctrees,而不是出现递归错误.
#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日）¶

不兼容更改¶

The py:module directive doesn’t output its platform option value anymore. (It was the only thing that the directive did output, and therefore quite inconsistent.)
删除了对旧依赖版本的支持;现在的要求是:
- Pygments >= 1.2
- Docutils >= 0.7
- Jinja2 >= 2.3

特性新增¶

添加了对Python 3.x的支持.
新构建器和子系统:
- 增加了一个Texinfo构建器.
- 添加了内容的国际化支持,添加了 gettext 构建器及相关工具.
- 添加了 websupport 库和构建工具.
- #98: 添加了一个 sphinx-apidoc 脚本,该脚本自动生成包含 autodoc 指令的源文件层次结构,以记录模块和包.
- #273:添加一个API,用于为英语以外的语言添加全文搜索支持.添加对日语的支持.
Markup:
- #138: 添加了一个 index 角色,以便生成内联索引条目.
- #454: 增加了更多的索引标记功能:标记查看/另见条目,以及给定键的主要条目.
- #460: 允许使用 toctree 的 numbered 选项来限制 HTML 中章节编号的深度.
- #586: 实现了改进的 glossary 标记,允许为每个定义添加多个术语.
- #478: 添加了 py:decorator 指令以描述装饰器.
- C++ 领域现在支持数组定义.
- C++域现在支持文档字段（ :param x: 在指令内部）.
- 在:rst:dir: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 和:confval:linkcheck_workers .
- #521: 添加了 linkcheck_ignore 配置值.
- #28: 在LaTeX构建器中支持表格的row/colspans.
配置与扩展性:
- #537: 添加了 nitpick_ignore .
- #306: 添加了 env-get-outdated 事件.
- Application.add_stylesheet() 现在接受完整的URI.
自动文档:
- #564: 添加 autodoc_docstring_signature .启用时（默认）,autodoc 会从文档字符串的第一行获取签名,如果在那里找到了.
- #176: 为 autodoc 指令提供 private-members 选项.
- #520: 为 autodoc 指令提供 special-members 选项.
- #431: 现在可以在赋值的同一行给属性添加文档注释.
- #437: autodoc 现在显示类数据属性的值.
- autodoc 现在支持文档化 functools.partial 对象的签名.
其他扩展:
- 添加了 sphinx.ext.mathjax 扩展.
- #443: 允许引用外部graphviz文件.
- 添加了 inline 选项到 graphviz 指令,并修复了 LaTeX 输出中的默认（块式）设置.
- #590: 为graphviz指令添加 caption 选项.
- #553: 在 doctest 扩展中增加了 testcleanup 块.
- #594:trim_doctest_flags 现在也会移除 <BLANKLINE> 指示符.
- #367: 添加了在继承图中自动排除隐藏成员的功能,以及一个可选择启用该功能的选项.
- 添加了 pngmath_add_tooltips .
- 数学扩展显示公式指令现在除了 label 外,还支持 name 来给方程式标签,以便与 Docutils 兼容.
新区域:
- #221: 添加了瑞典语区域设置.
- #526: 添加了伊朗地区设置.
- #694: 添加了拉脱维亚语环境.
- 添加了尼泊尔语区域设置.
- #714: 添加了韩语语言环境.
- #766: 添加了爱沙尼亚语区域设置.
修复的错误:
- #778: 修复在搜索链接的页面上 “隐藏搜索匹配项” 链接.
- 修复 “viewcode” 扩展引用的源位置.