Sphinx0.6¶

版本0.6.7（2010年6月5日）¶

#440：删除中Python >= 2.5 API的使用 literalinclude 指令。
修复了一个阻止在LaTeX构建器中生成某些引用的错误。
#428：为标准Docutils类添加一些缺失的CSS样式。
#432：在翻译的区域设置中构建LaTeX时修复UnicodeErrors。

版本0.6.6（2010年5月25日）¶

处理中的原始节点 text 作家.
修复Qt帮助项目产生的问题 qthelp 生成器将导致Qt Assistant中不显示任何内容。
#393：修复使用时数学公式中Unicode字符的使用 pngmath 扩展名.
第404章：你是谁 \and 在作者领域正常工作 latex_documents 设置.
#409：制作 highlight_language 配置值在LaTeX构建器中正常工作。
#418：允许将翻译JavaScript文件重新定位到Unix系统上的系统目录。
#414：修复包含的文件中Windows白线的处理 literalinclude 指令。
#377：修复linkcheck生成器中的崩溃。
第387章：一个人的世界 dirhtml 输出.
#376：在autodoc中，修复了包含反斜杠的参数默认值的显示。
#370：修复LaTeX输出中复杂列表项标签的处理。
#374：制作 doctest_path docTest扩展的配置值实际上有效。
修复为创建全局目录时多个toctree的处理 toctree() 模板功能。
修复为创建全局目录时隐藏toctree的处理 toctree() 模板功能。
修复文本编写器中嵌套列表的处理。
#362：在autodoc中，检查是否存在 __self__ 在访问函数对象之前。
#353：在搜索函数中提取搜索词时，删除开头和结尾空白。

版本0.6.5（2010年3月1日）¶

在autodoc中，修复使用文档注释显式记录的一些模块成员的省略。
第345章：我的女人 stickysidebar 默认主题的选项。
#341：始终在快速启动Makefile中生成UNITED新元素。
#338：修复运行时使用 -C 在Windows下。
在autodoc中，允许自定义内置机制失败的对象的签名。
#331：修复LaTeX中具有开始值的列举列表的输出。
使 start-after 和 end-before 购股权予 literalinclude 如果不一起使用，指令可以正常工作。
#321：修复LaTeX构建器中的链接生成。

版本0.6.4（2010年1月12日）¶

改进配置中非Unicode字符串的处理。
#316：用它不理解的参数调用graphviz时发生的OSE错误。
恢复与Pygments的兼容性>= 1.2。
#295：修复LaTeX输出中Hyperref目标的逸出。
#302：修复由 :doc: LaTeX输出的角色。
#286：在阅读整个文档后收集todo节点;这允许在todo项中放置替代引用。
#294：不要忽视显式的 today LaTeX构建中的配置值。
的 alt 继承图的文本现在干净多了。
生成链接标题时忽略部分标题中的图像。
#310：支持中的异常消息 testoutput 块 doctest 扩展名.
#293：行块在HTML输出中正确样式化。
#285：制作 locale_dirs 配置值再次工作。
#303： html_context 在命令行上通过 -A 不应该覆盖conf.py中给出的其他值。
修复了阻止增量重建的错误 dirhtml 建造者。
#299：修复某些文字块中引号的损坏。
#292：修复搜索索引的路径 dirhtml 建造者。
修复Jython兼容性问题：依赖 parser 模块可选。
#238：在autodoc中，捕获模块导入时发生的所有错误，而不仅仅是 ImportError .
修复autodoc中非数据但非方法描述符的处理。
复制文件时间时，忽略由引起的OSEerrors os.utime() .

版本0.6.3（2009年9月3日）¶

在autodoc中正确添加C模块文件名作为依赖项。
#253：忽略没有内容的graphviz指令，而不是引发未处理的异常。
#241：修复包含todolist指令的文档的崩溃构建LaTeX输出。
#252：更容易更改Quickstart生成的Makefiles中的构建目录。
#220：修复CSS，以便显示数学真正以中心为中心。
#222：允许翻译“Footnotes”标题。
#225：不要在内联标签后在生成的HTML中添加空白。
#227：制作 literalinclude 当文档的路径名包含非ASCI字符时起作用。
#229：修复导致错误的成员的autodoc失败 getattr() .
#205：复制文件时，不要复制完整的统计信息，只复制修改时间。
#232：Qt帮助构建器中支持非ASC元数据。
正确格式化嵌套在LaTeX定义列表中的项目符号列表。
现在允许在里面使用版块标题 only 指令。
#201：制作 centered LaTeX输出中的指令工作。
#206：拒绝覆盖phinx-quickstart中的现有主文档。
#208：使用MS认可的区域设置，由 language 配置选项，在HTML帮助生成器中。
#210：修复pngmath扩展中显示的数学的HTML标签的嵌套。
#213：修复LaTeX输出中图像的居中问题。
#211：修复与Docutils 0.5的兼容性。

版本0.6.2（2009年6月16日）¶

#130：修复docTest扩展中模糊的Index错误。
#167：使术语表排序独立于案例。
#196：如果扩展模块没有，则添加警告 setup() 功能
#158：允许'. '在模板名称和绝对模板路径中; Jinja 2默认禁用两者。
当突出显示Python代码时，请在尝试将其解析为Python之前忽略额外的凹痕。
#191：不要逃避LaTeX中URIs中的波浪形。
不要考虑搜索索引的源评论内容。
将默认编码设置为 utf-8-sig 正确处理具有UTF-8物料清单的文件。
#178：申请 add_function_parentheses 配置值到C功能，正如承诺的那样。
#173：尊重Docutils title 指令。
#172： obj 角色现在按照承诺链接到模块。
#19：表现在可以有一个“longtable”类，以便在LaTeX输出中正确分解为页面。
尝试之前，请在系统默认路径中查找Sphinx消息目录 sphinx/locale .
修复通过“className.MethodName”搜索方法的问题。
#155：修复Python 2.4兼容性：异常是那里的老式类。
#150：修复Internet Explorer版本6和7上“phinxDoc”主题的显示。
#146：当用户有活动时，不要失败生成LaTeX .docutils 配置.
#29：不要在LaTeX的选项列表中生成可见的“-{-}”。
在进行替换时修复交叉引用角色。
不要将图像“alt”文本放入目录条目中。
在LaTeX writer中，不要在太多的部分级别上引发异常，只需对所有部分使用“子分段”级别即可。
#145：修复拒绝从其父级获取attr（）' d的自动成员的autodoc问题。
如果命令行上给出了要生成的特定文件名，请检查它们是否位于源目录中。
修复没有对象的autodoc崩溃 __name__ .
修复没有urllib2.HTTPSHandler的安装的interphinx。
#134：使用todo扩展中的todolist指令时修复pending_xref剩余节点。

版本0.6.1（2009年3月26日）¶

#135：修复LaTeX输出和graphviz扩展的问题。
#132：在分发中包括自动摘要“模块”模板。

版本0.6（2009年3月24日）¶

新增的功能¶

不兼容的更改：
- 模板现在需要Jinja 2库，这是旧Jinja 1引擎的增强版本。由于语法和语义基本相同，因此自定义模板中需要进行很少的修复。
- “文档”dis标签已从 layout.html 模板的“文档”块，因为结束标签已经在外面。如果覆盖此块，则还需要删除“doctor”dis标签。
- 的 autodoc_skip_member 事件现在还可以决定是否跳过名称以下划线开头的成员。以前，这些成员总是被自动跳过。因此，如果您处理此事件，请向事件处理程序中添加以下内容以恢复旧行为：
```
if name.startswith('_'):
    return True
```
主题支持，请参阅文档中的新部分。
标记：
- 由于大众需求，补充道 :doc: 直接链接到另一个文档的角色，而无需创建 :ref: 可以链接到。
- #4：添加了 :download: 标记非文档文件以包含在HTML输出中并链接到该文件的角色。
- 增加了一个 only 可以根据启用的“标签”选择性地包括文本的指令。标签可以在命令行上给出。此外，当前的构建器输出格式（例如“html”或“latex”）始终是已定义的标签。
- #10：添加了HTML小节号，通过提供 :numbered: 标志到 toctree 指令。
- #114：添加了 abbr 标记缩写和首字母缩略词的角色。
- 的 literalinclude 指令现在支持多个选项，以仅包含文件的部分。
- 的 toctree 指令现在支持 :hidden: 标志，这将防止生成链接来代替指令--这允许您定义文档结构，但您自己放置链接。
- #123： glossary 指令现在支持 :sorted: 按字母顺序对术语表条目进行排序的标志。
- 图像、文本包含文件和下载文件的路径现在可以是绝对的（例如 /images/foo.png ). 它们被视为相对于顶级源目录。
- #52：现在有一个 hlist 指令，通过将分发项放入多列来创建紧凑列表。
- #77：如果具有信息字段列表的描述环境仅包含一个 :param: 条目，不生成项目符号列表。
- #6：不要生成冗余 <ul> 用于顶级目录树项，这会导致目录条目的视觉分离。
- #23：添加了 classmethod 指令以及 method 和 staticmethod .
- 缩放的图像现在可以链接到未缩放的版本。
- HTML中现在支持JPEG图像（通过 <object> 和 <embed> 标签）。
- 增加了一个 toctree 可调用的模板，并能够包括外部链接的toctree。“collapse”关键字参数指示是否仅显示当前页面的子项。（图） True .)
配置：
- 新的配置值 rst_epilog 可以包含附加到读取的每个源文件的reST。这是全局替换的正确位置。
- 新 html_add_permalinks 配置值可用于关闭每个标题和定义环境生成的“段落符号”永久链接。
- 新 html_show_sourcelink 配置值可用于关闭侧边栏中reST源的链接。
- 的默认值 htmlhelp_basename 现在是项目标题，已清理为文件名。
- 新 modindex_common_prefix 配置值可用于忽略某些包名称进行模块索引排序。
- 新 trim_footnote_reference_space 配置值镜像同名的Docutils配置值，并删除reST识别引用所需的脚注引用之前的空白。
- 新 latex_additional_files 配置值可用于复制文件（Sphinx不会自动复制，例如，如果它们在添加的自定义LaTeX中引用 latex_elements ）到构建目录。
构建器：
- HTML生成器现在存储一个名为 .buildinfo 在其输出目录中。它存储配置值的哈希，可用于确定是否需要进行完整重建（例如在更改后 html_theme ).
- Qt帮助系列的新构建者，作者：Antonio Valentino。
- 新 DirectoryHTMLBuilder （简称 dirhtml ）为每个页面创建一个单独的目录，并将页面放入名为 index.html . 因此，页面URL和链接不需要包含 .html .
- 新 html_link_suffix 配置值可用于选择HTML文件之间生成的链接的后缀。
- #96：LaTeX构建器现在支持由文本包裹的图形，使用 figwidth 选项和右/左对齐。
新翻译：
- 意大利语作者：Sandro Dentella。
- 乌克兰语作者：Petro Sasnyk。
- 芬兰语作者：Jukka Inkeri。
- 亚历山大·史密斯拉耶夫的俄语。
扩展和API：
- 新 graphviz 嵌入graphviz图形的扩展。
- 新 inheritance_diagram 要嵌入的扩展.继承图！
- 新 autosummary 生成模块摘要和模块自动文档的扩展。
- Autodoc现在拥有一个可重复使用的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自己的功能。
其他变化：
- 现在可以在命令行上给出单个dict键的配置覆盖。
- 现在有一个 doctest_global_setup 配置值，可用于为文档中所有doctests提供设置代码。
- HTML中的源代码链接现在可以用 rel="nofollow" .
- Quickstart现在可以生成Windows make.bat 文件.
- #62：现在有一个 -w 除了stderr之外，用于将警告写入文件的phinx-Build选项。
- 现在有一个 -W 用于将警告转化为错误的狮身X构建选项。