Sphinx 0.4

发布 0.4.3 (2008年10月8日)

  • 修复了在直接给定自动文档成员时出现的 autodoc 错误.

  • 修复了autodoc中的一个漏洞,该漏洞会将模块导入两次,一次为”module”,一次为”module.”.

  • 修复了HTML写入器中的一个错误,该错误导致在使用Docutils 0.5时为章节标题创建重复的 id 属性.

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

  • 当使用XeTeX时添加修复.

  • 统一处理 LaTeX 转义.

  • 当 extensions 配置值发生变化时,重新构建所有内容.

  • 不要尝试删除不存在的静态目录.

  • 修复生产列表中的缩进问题.

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

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

  • 修复由于不存在图像URI导致的崩溃.

发布 0.4.2 (2008年7月29日)

  • 修复HTML中 samp 角色的渲染.

  • 修复了LaTeX链接到标题导致跳转到错误页面的bug.

  • 在添加或删除源文件时,重新读取带有全局 toctrees 的文档.

  • 为PickleHTMLBuilder.handle_page()添加一个缺失的参数.

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

  • 不要自动将包含空白的代码用引号括起来;仅对 samp 角色执行此操作.

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

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

  • automodule 指令现在再次接受 inherited-members 和 show-inheritance 选项.

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

发布版本 0.4.1（2008年7月5日）

  • 向TextBuilder添加了上下标节点处理.

  • 引用中的标签名称现在不区分大小写,因为reST标签名称总是被转换为小写.

  • 修复因格式错误的URL造成的linkcheck构建崩溃.

  • 添加对告诫和Docutils 0.5的兼容性.

  • 删除LaTeX写入器中对”rubric”的愚蠢限制:现在你可以写任意的”rubric”指令,只有标题为”脚注”的指令会被忽略.

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

  • 修复模块名称和平台中带下划线的LaTeX代码.

  • 修复非本地图像URI导致的崩溃.

  • 允许在 automodule 指令中使用:noindex:,如文档所述.

  • 修复autodoc中 delete() 文档字符串处理器函数.

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

  • 修复Internet Explorer中的JavaScript搜索.

发布 0.4 (2008年6月23日)

新增功能

  • tocdepth can be given as a file-wide metadata entry, and specifies the maximum depth of a TOC of this file.

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

  • Sphinx 现在在描述单元中解释包含类似 :param foo: 的字段列表.

  • 新的 staticmethod 指令可以用来将方法标记为静态方法.

  • HTML 输出:

    • “上一页”和”下一页”链接具有更合乎逻辑的结构,因此通过点击”下一页”链接,您可以遍历整个目录树.

    • 新的事件 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 .

    • The directories in the html_static_path can now contain subdirectories.

    • 如果子模块的数量大于顶级模块的数量,则模块索引现在不会被折叠.

  • 图像指令现在支持将扩展名指定为 .* ,这使得构建器选择最匹配的一个.感谢Sebastian Wiesner.

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

  • 配置值的默认值现在可以是可调用对象,这允许动态默认值.

  • 新的TextBuilder生成纯文本输出.

  • 支持Python 3风格的签名,通过 -> 给出返回注解.

  • 扩展:

    • autodoc扩展现在提供了一种更灵活的方式来在将文档字符串包含到输出之前进行处理,通过新的 autodoc-process-docstring 事件.

    • The autodoc extension accepts signatures for functions, methods and classes now that override the signature got via introspection from Python code.

    • The autodoc extension now offers a show-inheritance option for autoclass that inserts a list of bases after the signature.

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

修复的错误

  • 正确报告使用autodoc包含的文档字符串的源位置.

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

  • 处理 LaTeX 输出中的图形指令.

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

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

  • 处理包含空格的项目名称.

  • 不要在 HTML 输出中写 SSI 类似的注释.

  • 将 “sidebar “ 类重命名为 “sphinxsidebar” 以与 reST 侧边栏区分开.

  • 在HTML帮助生成中使用二进制目录以修复没有明确锚点的链接问题.

  • 修复对具有明确标题的函数/方法的引用行为.

  • 支持在 LaTeX 写入器中使用引用、下标和上标节点.

  • 将标准的”class”指令提供为”cssclass”;否则,它将被Sphinx定义的指令覆盖.

  • 修复了在autoclass指令中给定的显式模块名称的处理.它们现在在生成的文档中显示正确的模块名称.

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

  • LaTeX编写器现在将行块翻译为``raggedright’’,这与表格的兼容性更好.

  • 修复HTML构建器静态路径中与目录相关的错误.