Sphinx0.4

版本0.4.3（2008年10月8日）

  • 修复了直接指定autodoc成员的autodoc中的错误。

  • 修正了autodoc中的一个错误，它会两次导入一个模块，一次是“模块”，一次是“模块”。".

  • 修复创建重复内容的HTML编写器中的错误 id Docutils 0.5的章节标题的属性。

  • 正确调用 super() 在模板中的覆盖块中。

  • 使用XeTeX时添加修复程序。

  • 统一LaTeX逃逸处理。

  • 当 extensions 配置值更改。

  • 不要试图删除不存在的静态目录。

  • 修复生产列表中的缩入问题。

  • 修复文本包含文件的编码处理： literalinclude 现在有一个 encoding 默认为UTF-8的选项。

  • 修复快速启动中输入的非ASC字符的处理。

  • 修复不存在的图像uri的崩溃。

版本0.4.2（2008年7月29日）

  • 修复 samp HTML中的角色。

  • 修复LaTeX链接导致错误页面的标题错误。

  • 添加或删除源文件时，重新阅读带有球状toctree的文档。

  • 将丢失的参数添加到PickleHTMLBuilder.handle_page（）。

  • 始终将继承信息放在自己的行上。

  • 不要自动将带有空白的代码放在引号中;仅对 samp 作用

  • 当无法导入模块或找不到属性时，autodoc现在会发出更精确的错误消息。

  • JavaScript搜索现在在引用找到的项目时使用正确的文件名后缀。

  • automobile指令现在接受 inherited-members 和 show-inheritance 再次选择。

  • 重新定位源和/或doctree目录后，您现在可以正常重建文档。

版本0.4.1（2008年7月5日）

  • 向文本生成器添加了子/superScript节点处理。

  • 参考中的标签名称现在不区分大小写，因为reST标签名称始终是大写的。

  • 修复格式错误的URL的链接检查生成器崩溃。

  • 添加警告和Docutils 0.5的兼容性。

  • 删除LaTeX编写器中对“rubric”的愚蠢限制：您现在可以编写任意的“rubric”指令，并且只有标题为“Footnotes”的指令才会被忽略。

  • 将HTML徽标复制到输出 _static 目录.

  • 修复名称和平台中带有星号的模块的LaTeX代码。

  • 修复非本地图像URIs的崩溃。

  • 允许使用：noindex：in automodule 指令，如文件所示。

  • 固定 delete() autodoc中的doc字符串处理器功能。

  • 修复不存在图像的警告消息。

  • 修复Internet Explorer中的JavaScript搜索。

版本0.4（2008年6月23日）

新增的功能

  • tocdepth 可以作为文件范围的元数据条目给出，并指定此文件的目录的最大深度。

  • 新的配置值 default_role 可用于选择所有文档的默认角色。

  • Sphinx现在用以下字段解释字段列表 :param foo: 以描述单位为单位。

  • 新 staticmethod 指令可用于将方法标记为静态方法。

  • HTML输出：

    • “上一个”和“下一个”链接具有更具逻辑性的结构，因此通过遵循“下一个”链接，您可以穿越整个目录树。

    • 新事件 html-page-context 可用于在呈现HTML模板时将自定义值包含到上下文中。

    • 文档元数据现在位于默认模板上下文中，名称为 metadata .

    • 新的配置值 html_favicon 可用于为HTML输出设置favicon。 感谢塞巴斯蒂安·威斯纳。

    • 新的配置值 html_use_index 可用于关闭HTML文档中的索引生成。

    • 新的配置值 html_split_index 可用于为每个字母创建单独的索引页面，当完整索引对于一个页面来说太大时使用。

    • 新的配置值 html_short_title 可用于为文档设置较短的标题，然后在导航栏中使用该标题。

    • 新的配置值 html_show_sphinx 可用于控制是否将指向Sphinx的链接添加到HTML页脚。

    • 新的配置值 html_file_suffix 可用于将HTML文件后缀设置为例如 .xhtml .

    • 中的目录 html_static_path 现在可以包含子目录。

    • 如果子模块的数量大于顶层模块的数量，模块索引现在不会折叠。

  • 图像指令现在支持将扩展名指定为 .* ，这使得构建者选择最匹配的。 感谢塞巴斯蒂安·威斯纳。

  • 新的配置值 exclude_trees 可用于从源文件搜索中排除整个子树。

  • 配置值的预设现在可以是可调用的，这允许动态默认值。

  • 新的文本生成器创建纯文本输出。

  • Python 3风格签名，通过提供返回注释 -> ，现已支持。

  • 扩展：

    • autodoc扩展现在提供了一种更灵活的方式来操作文档字符串，然后通过新的 autodoc-process-docstring 活动

    • 的 autodoc 扩展现在接受函数、方法和类的签名，这些签名覆盖通过Python代码的内省获得的签名。

    • 的 autodoc 扩展现在提供 show-inheritance 自动类选项，在签名后插入碱基列表。

    • autodoc指令现在支持 noindex 标志选项。

错误已修复

  • 正确报告autodoc中包含的文档字符串的源位置。

  • 修复具有多个签名的描述单元的LaTeX输出。

  • 处理LaTeX输出中的人物指令。

  • 处理LaTeX输出中的原始警告。

  • 修复HTML帮助输出中标题的确定。

  • 处理包含空白的项目名称。

  • 不要在HTML输出中编写类似SS的评论。

  • 将“sidebar”类重命名为“sphinxsidebar”，以保持与reST侧边栏的不同。

  • 在HTML帮助生成中使用二进制目录来修复没有显式锚点的问题链接。

  • 修复对具有显式标题的函数/方法的引用的行为。

  • 支持LaTeX writer中的引用、脚注和superScript节点。

  • 将标准的“类”指令提供为“cssclass”;否则它将被Sphinx定义的指令所遮蔽。

  • 修复赋予autoclass指令的显式模块名称的处理。现在，它们在生成的文档中以正确的模块名称显示。

  • 启用autodoc以处理Unicode文档字符串。

  • LaTeX编写者现在将行块翻译为 \raggedright ，它与桌子一起玩得更好。

  • 修复HTML生成器静态路径中目录的错误。