Sphinx 0.6

Release 0.6.7 (2010年6月5日)

  • #440: 在 literalinclude 指令中移除对 Python >= 2.5 API 的使用.

  • 修复了一个在 LaTeX 构建器中阻止某些引用生成的错误.

  • #428: 为标准Docutils类添加一些缺失的CSS样式.

  • #432: 修复在翻译区域构建LaTeX时的UnicodeErrors.

Release 0.6.6（2010年5月25日）

  • 处理 text 写入器中的原始节点.

  • 修复通过 qthelp 构建器生成的 Qt 帮助项目中的一个问题,该问题会导致 Qt Assistant 中不显示任何内容.

  • #393: 修复在使用 pngmath 扩展时数学公式中Unicode字符的使用.

  • #404: 使 \and 在 latex_documents 设置的作者字段中正常工作.

  • #409: 使 highlight_language 配置值在 LaTeX 构建器中正常工作.

  • #418: 允许在Unix系统上将翻译的JavaScript文件移动到系统目录.

  • #414: 修复通过 literalinclude 指令包含的文件中 Windows 换行符的处理.

  • #377: 修复 linkcheck 构建器中的崩溃问题.

  • #387: 修复 dirhtml 输出中搜索结果的显示.

  • #376: 在autodoc中,修复包含反斜杠的参数默认值的显示.

  • #370:修复了LaTeX输出中复杂列表项标签的处理.

  • #374: 使得doctest扩展的 doctest_path 配置值实际生效.

  • 修复在为 toctree() 模板函数创建全局 TOC 时对多个 toctrees 的处理.

  • 修复在为 toctree() 模板函数创建全局 TOC 时对隐藏 toctree 的处理.

  • 修复文本写入器中嵌套列表的处理.

  • #362: 在autodoc中,在访问函数对象的 __self__ 之前检查其是否存在.

  • #353:在搜索功能中提取搜索词时,去除前后的空白.

Release 0.6.5 (2010年3月1日)

  • 在autodoc中修复一些使用文档注释明确记录的模块成员被遗漏的问题.

  • #345: 修复默认主题中使用 stickysidebar 选项时侧边栏滚动条的裁剪问题.

  • #341: 在快速启动的Makefile中始终生成UNIX换行符.

  • #338: 修复在Windows下使用 -C 运行的错误.

  • 在autodoc中,允许定制一个对象的签名,当内置机制失败时.

  • #331: 修复LaTeX中带起始值的枚举列表的输出.

  • 使 literalinclude 指令的 start-after 和 end-before 选项在未一起使用时正确工作.

  • #321: 修复LaTeX构建器中的链接生成.

版本 0.6.4（2010年1月12日）

  • 改进配置中对非Unicode字符串的处理.

  • #316: 捕获在调用 graphviz 时因其不理解的参数而发生的 OSErrors.

  • 恢复对 Pygments >= 1.2 的兼容性.

  • #295: 修复LaTeX输出中hyperref目标字符的转义问题.

  • #302: 修复通过 :doc: 角色为 LaTeX 输出生成的链接.

  • #286: 在整个文档读取后收集待办节点;这允许将替代引用放入待办事项中.

  • #294: 在LaTeX构建中不要忽视显式的 today 配置值.

  • 继承图的 alt 文本现在更加简洁.

  • 忽略节标题中的图像,以生成链接标题.

  • #310: 在 doctest 扩展的 testoutput 块中支持异常消息.

  • #293: 行块在HTML输出中样式正确.

  • #285: 使 locale_dirs 配置值重新生效.

  • #303: 通过 -A 在命令行中给出的 html_context 值不应覆盖在 conf.py 中给出的其他值.

  • 修复一个阻止 dirhtml 构建器增量重建的错误.

  • #299: 修复某些文字块中引号的破坏问题.

  • #292: 修复 dirhtml 构建器的搜索索引路径.

  • 修复Jython的兼容性问题:使对 parser 模块的依赖成为可选.

  • #238: 在autodoc中,捕获所有在模块导入时发生的错误,而不仅仅是 ImportError .

  • 修复自动文档中对非数据但非方法描述符的处理.

  • 当复制文件时间时,忽略 os.utime() 引发的 OSErrors.

版本 0.6.3（2009年9月3日）

  • 正确地将C模块文件名作为依赖项添加到autodoc中.

  • #253: 忽略没有内容的graphviz指令,而不是引发未处理的异常.

  • #241: 修复在构建包含待办事项指令的文档的LaTeX输出时崩溃的问题.

  • #252: 使通过 quickstart 生成的 Makefiles 中更改构建目录变得更容易.

  • #220:修复CSS,使得displaymath确实居中.

  • #222: 允许翻译 “脚注” 标题.

  • #225: 在生成的 HTML 中,在线标签后不要添加空白.

  • #227: 使 literalinclude 在文档的路径名包含非ASCII字符时也能正常工作.

  • #229: 修复在 getattr() 上引发错误的成员导致的 autodoc 失败.

  • #205: 复制文件时,不要复制完整的状态信息,仅复制修改时间.

  • #232: 支持在Qt帮助生成器中使用非ASCII元数据.

  • 正确格式化嵌套在定义列表中的LaTeX子弹列表.

  • 现在允许在 only 指令内部包含章节标题.

  • #201: 使 centered 指令在 LaTeX 输出中正常工作.

  • #206: 在sphinx-quickstart中拒绝覆盖现有的主文档.

  • #208: 在HTML帮助生成器中使用由 language 配置选项确定的MS授权的语言环境设置.

  • #210: 修复pngmath扩展中显示数学时HTML标签的嵌套问题.

  • #213: 修复LaTeX输出中图像的居中问题.

  • #211: 修复与 Docutils 0.5 的兼容性.

发行版本 0.6.2 (2009年6月16日)

  • #130: 修复doctest扩展中的模糊IndexError.

  • #167: 使术语表排序不区分大小写.

  • #196: 如果扩展模块没有 setup() 函数,则添加警告.

  • #158: 允许在模板名称中使用’..’,以及绝对模板路径;Jinja 2 默认禁用这两者.

  • 当高亮显示 Python 代码时,在尝试将其解析为 Python 之前,忽略额外的缩进.

  • #191: 在LaTeX中不要在URI中转义波浪号.

  • 不要将源评论的内容考虑在搜索索引中.

  • 将默认编码设置为 utf-8-sig 以正确处理带有 UTF-8 BOM 的文件.

  • #178: 按照承诺,将 add_function_parentheses 配置值应用于 C 函数.

  • #173: 尊重 Docutils 的 title 指令.

  • #172:obj 角色现在按照承诺链接到模块.

  • #19:表格现在可以有一个 “longtable” 类,以便在 LaTeX 输出中正确分页.

  • 在尝试 sphinx/locale 之前,先在系统默认路径中查找 Sphinx 消息目录.

  • 修复通过 “classname.methodname” 搜索方法的问题.

  • #155:修复 Python 2.4 兼容性:异常是旧式类.

  • #150: 修复在Internet Explorer 6和7版本中”sphinxdoc”主题的显示问题.

  • #146: 当用户有一个活动的 .docutils 配置时,不要生成 LaTeX 失败.

  • #29: 在LaTeX的选项列表中不生成可见的 “-{-}”.

  • 修复在替换中放入交叉引用角色时的问题.

  • 不要将图像的 “alt” 文本放入目录条目中.

  • 在LaTeX编写器中,对于过多的节级,不要引发异常,只需对所有级别使用”子段落”级别.

  • #145: 修复自动文档生成中自动成员无法从其父类获取 getattr() 的问题.

  • 如果在命令行中给出了特定的要构建的文件名,请检查它们是否在源目录中.

  • 修复没有 __name__ 的对象导致的 autodoc 崩溃.

  • 修复在没有 urllib2.HTTPSHandler 的安装情况下的 intersphinx 问题.

  • #134: 修复在使用 todo 扩展中的 todolist 指令时剩余的 pending_xref 节点.

Release 0.6.1（2009年3月26日）

  • #135: 修复LaTeX输出和graphviz扩展的问题.

  • #132: 在发行版中包含 autosummary “模块” 模板.

Release 0.6 (2009年3月24日)

新功能增加

  • 不兼容的更改:

    • 模板现在需要 Jinja2 库,这是旧的 Jinja1 引擎的增强版本.由于语法和语义大致相同,因此在自定义模板中几乎不需要进行修复.

    • “document” div 标签已被移出 layout.html 模板的”document”块,因为闭合标签已经在外面.如果你覆盖这个块,你需要删除你的”document” div 标签.

    • The autodoc_skip_member event now also gets to decide whether to skip members whose name starts with underscores. Previously, these members were always automatically skipped. Therefore, if you handle this event, add something like this to your event handler to restore the old behavior:

      if name.startswith('_'):
    return True

  • 主题支持,请参阅文档中的新部分.

  • Markup:

    • 由于广泛需求,新增了 :doc: 角色,该角色可以直接链接到另一个文档,而无需创建要链接的 :ref: 标签.

    • #4: 添加了一个 :download: 角色,用于标记非文档文件以便包含在HTML输出中并链接到该文件.

    • 增加了一个 only 指令,可以根据启用的 “tags” 有选择性地包含文本.标签可以在命令行中给出.此外,当前构建器的输出格式（例如 “html” 或 “latex”）始终是一个定义的标签.

    • #10: 添加了HTML章节编号,通过给 toctree 指令添加 :numbered: 标志来启用.

    • #114: 增加了一个 abbr 角色来标记缩写和首字母缩写.

    • The literalinclude directive now supports several more options, to include only parts of a file.

    • The toctree directive now supports a :hidden: flag, which will prevent links from being generated in place of the directive – this allows you to define your document structure, but place the links yourself.

    • #123:glossary 指令现在支持 :sorted: 标志,该标志按字母顺序对术语表条目进行排序.

    • 图像、文字包含文件和下载文件的路径现在可以是绝对路径（如 /images/foo.png ）.它们被视为相对于顶级源目录.

    • #52: 现在有一个 hlist 指令,通过将项目分布到多个列来创建一个紧凑的列表.

    • #77: 如果描述环境中的信息字段列表仅包含一个 :param: 条目,则不生成项目符号列表.

    • #6: 不要为顶级 TOC 树项生成冗余的 <ul> ,这会导致 TOC 条目之间的视觉分隔.

    • #23: 添加了 classmethod 指令,以及 method 和 staticmethod .

    • 缩放的图像现在会链接到未缩放版本.

    • SVG 图像现在在 HTML 中得到支持（通过 <object> 和 <embed> 标签）.

    • 添加了一个 toctree 可调用项到模板中,并且在toctree中包含外部链接的能力.’collapse’关键字参数指示是否仅显示当前页面的子项目.（默认为 True .）

  • 配置:

    • 新配置值 rst_epilog 可以包含附加到每个被读取的源文件的 reST.这是进行全局替换的合适地方.

    • 新的 html_add_permalinks 配置值可以用来关闭为每个标题和定义环境生成的 “段落符号” 永久链接.

    • 新的 html_show_sourcelink 配置值可以用来关闭侧边栏中指向 reST 源代码的链接.

    • The default value for htmlhelp_basename is now the project title, cleaned up as a filename.

    • 新的 modindex_common_prefix 配置值可以用来忽略某些包名称,以便进行模块索引排序.

    • 新的 trim_footnote_reference_space 配置值镜像了同名的 Docutils 配置值,移除了在脚注引用之前所需的空格,以使 reST 识别该引用.

    • 新的 latex_additional_files 配置值可以用于将文件复制到构建目录（Sphinx 默认不会自动复制这些文件,例如,如果它们在 latex_elements 中自定义的 LaTeX 中被引用）.

  • Builders:

    • HTML构建器现在在其输出目录中存储一个名为 .buildinfo 的小文件.它存储一个配置值的哈希,用于确定是否需要进行完全重建（例如,在更改 html_theme 之后）.

    • 新的Qt帮助集合构建器,由Antonio Valentino提供.

    • 新的 DirectoryHTMLBuilder (简称 dirhtml ) 为每个页面创建一个单独的目录,并将页面放置在名为 index.html 的文件中.因此,页面的 URL 和链接不需要包含 .html .

    • 新的 html_link_suffix 配置值可用于选择生成的 HTML 文件链接的后缀.

    • #96: LaTeX构建器现在支持被文本包围的图形,当使用 figwidth 选项并进行右/左对齐时.

  • 新翻译:

    • 意大利语 由 Sandro Dentella.

    • 乌克兰文 彼得·萨斯尼克.

    • 芬兰语 由 Jukka Inkeri 提供.

    • 俄罗斯语 由 亚历山大·斯米什拉耶夫.

  • 扩展和 API:

    • 新 graphviz 扩展用于嵌入 graphviz 图.

    • 新的 inheritance_diagram 扩展用于嵌入… 继承图!

    • 新的 autosummary 扩展,可生成模块的摘要和模块的自动文档.

    • 自动文档功能现在拥有可重用的Python API,可以用来创建自定义类型的对象以进行自动文档编制（例如Zope接口）.另请参见 Sphinx.add_autodocumenter() .

    • Autodoc 现在处理文档化的属性.

    • Autodoc 现在处理内部类及其方法.

    • Autodoc现在可以将类作为函数进行文档记录,如果明确标记为 autofunction .

    • Autodoc 现在可以通过 exclude-members 选项排除单个成员的文档.

    • Autodoc现在可以按字母顺序（如之前一样）或按成员类型对成员进行排序;可以通过配置值 autodoc_member_order 或每个指令的 member-order 选项进行配置.

    • 函数 Sphinx.add_directive() 现在也支持 Docutils 0.5 样式的指令类.如果它们继承自 sphinx.util.compat.Directive ,它们也可以与 Docutils 0.4 一起使用.

    • 现在有了 Sphinx.add_lexer() 方法,可以轻松使用自定义的 Pygments 词法分析器.

    • 现在有 Sphinx.add_generic_role() 来镜像 Docutils 自身的功能.

  • 其他变化:

    • 现在可以在命令行中为单个字典键提供配置覆盖.

    • 现在有一个 doctest_global_setup 配置值,可以用于为文档中的所有 doctest 提供设置代码.

    • HTML中的源链接现在生成了 rel="nofollow" .

    • 快速入门现在可以生成一个 Windows make.bat 文件.

    • #62: 现在,sphinx-build 有一个 -w 选项,可以将警告写入文件,除了标准错误输出外.

    • 现在,sphinx-build 有一个 -W 选项,可以将警告转换为错误.