Sphinx 0.4¶

发布 0.4.3 (2008年10月8日)¶

修复 autodoc 中直接给出 autodoc 成员的错误。
修复 autodoc 中的一个错误，该错误会导致模块导入两次，一次为“module”，一次为“module.”。
修复 HTML 写入器中的一个错误，该错误在 Docutils 0.5 中为章节标题创建了重复的 id 属性。
在模板中被覆盖的块中正确调用 super()。
添加使用 XeTeX 时的修复。
统一处理 LaTeX 转义。
当 extensions 配置值更改时，重建所有内容。
不要尝试删除不存在的静态目录。
修复生产列表中的缩进问题。
修复文字包含文件的编码处理：literalinclude 现在有一个 encoding 选项，默认为 UTF-8。
修复 quickstart 中输入的非 ASCII 字符的处理。
修复不存在的图像 URI 导致的崩溃。

发布 0.4.2 (2008年7月29日)¶

修复 HTML 中 samp 角色的渲染。
修复 LaTeX 链接到导致错误页面的标题的错误。
当源文件被添加或删除时，重新读取带有 globbed toctree 的文档。
为 PickleHTMLBuilder.handle_page() 添加一个缺失的参数。
始终将继承信息放在其自己的行上。
不要自动将包含空格的代码用引号括起来；只对 samp 角色执行此操作。
当模块无法导入或属性无法找到时，autodoc 现在会发出更精确的错误消息。
JavaScript 搜索现在在引用找到的项目时使用正确的文件名后缀。
automodule 指令现在再次接受 inherited-members 和 show-inheritance 选项。
您现在可以在重新定位源和/或 doctree 目录后正常重建文档。

发布 0.4.1 (2008年7月5日)¶

为 TextBuilder 添加了下标/上标节点处理。
引用中的标签名称现在不区分大小写，因为 reST 标签名称总是小写。
修复格式错误的 URL 导致的 linkcheck 构建器崩溃。
添加与 Docutils 0.5 的 admonitions 兼容性。
删除 LaTeX 写入器中“rubric”的愚蠢限制：您现在可以编写任意“rubric”指令，只有标题为“Footnotes”的指令才会被忽略。
将 HTML 徽标复制到输出 _static 目录。
修复名称和平台中带有下划线的模块的 LaTeX 代码。
修复非本地图像 URI 导致的崩溃。
允许在 automodule 指令中使用 :noindex:，如文档所述。
修复 autodoc 中的 delete() docstring 处理器函数。
修复不存在图像的警告消息。
修复 Internet Explorer 中的 JavaScript 搜索。

发布 0.4 (2008年6月23日)¶

新增功能¶

tocdepth 可以作为文件范围的元数据条目给出，并指定此文件的 TOC 的最大深度。
新的配置值 default_role 可用于选择所有文档的默认角色。
Sphinx 现在解释带有 :param foo: 等字段的字段列表在描述单元中。
新的 staticmethod 指令可用于将方法标记为静态方法。
HTML 输出
- “上一个”和“下一个”链接具有更逻辑的结构，因此通过跟随“下一个”链接可以遍历整个 TOC 树。
- 新的事件 html-page-context 可用于在渲染 HTML 模板时将自定义值包含到上下文。
- 文档元数据现在在默认模板上下文中，名称为 metadata。
- 新的配置值 html_favicon 可用于为 HTML 输出设置 favicon。感谢 Sebastian Wiesner。
- 新的配置值 html_use_index 可用于关闭 HTML 文档中的索引生成。
- 新的配置值 html_split_index 可用于为每个字母创建单独的索引页，以用于完整索引太大而无法容纳在一个页面时。
- 新的配置值 html_short_title 可用于为文档设置一个较短的标题，然后将其用于导航栏。
- 新的配置值 html_show_sphinx 可用于控制是否在 HTML 页脚中添加指向 Sphinx 的链接。
- 新的配置值 html_file_suffix 可用于将 HTML 文件后缀设置为例如 .xhtml。
- html_static_path 中的目录现在可以包含子目录。
- 如果子模块的数量大于顶级模块的数量，则模块索引现在不会折叠。
图像指令现在支持将扩展名指定为 .*，这使得构建器选择最匹配的。感谢 Sebastian Wiesner。
新的配置值 exclude_trees 可用于将整个子树从源文件搜索中排除。
配置值的默认值现在可以是可调用对象，这允许动态默认值。
新的 TextBuilder 创建纯文本输出。
现在支持 Python 3 风格的签名，通过 -> 给出返回注释。
扩展
- autodoc 扩展现在提供了一种更灵活的方式来在将 docstring 包含到输出之前对其进行操作，通过新的 autodoc-process-docstring 事件。
- autodoc 扩展现在接受函数、方法和类的签名，这些签名会覆盖通过 Python 代码自省获得的签名。
- autodoc 扩展现在为 autoclass 提供了一个 show-inheritance 选项，该选项在签名后插入一个基类列表。
- autodoc 指令现在支持 noindex 标志选项。

修复的 Bug¶

正确报告包含在 autodoc 中的 docstring 的源位置。
修复带有多个签名的描述单元的 LaTeX 输出。
处理 LaTeX 输出中的 figure 指令。
处理 LaTeX 输出中的原始 admonitions。
修复 HTML 帮助输出中标题的确定。
处理包含空格的项目名称。
不要在 HTML 输出中写入 SSI 样式的注释。
将“sidebar”类重命名为“sphinxsidebar”以与 reST 侧边栏保持不同。
在 HTML 帮助生成中使用二进制 TOC 以修复没有显式锚点的链接问题。
修复对带有显式标题的函数/方法的引用的行为。
支持 LaTeX 写入器中的引文、下标和上标节点。
将标准“class”指令作为“cssclass”提供；否则它会被 Sphinx 定义的指令遮蔽。
修复传递给 autoclass 指令的显式模块名称的处理。它们现在在生成的文档中显示正确的模块名称。
启用 autodoc 处理 Unicode docstring。
LaTeX 写入器现在使用 \raggedright 转换行块，这与表格配合得更好。
修复 HTML 构建器静态路径中目录的错误。