Sphinx0.5¶

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

妥善逃生 | 在LaTeX输出中。
#71：如果源文件中发生解码错误，请打印警告并将字符替换为“？".
如果索引加载时间太长，请修复HTML搜索中的问题。
解析时不要输出系统消息，因为即使keep_warning为假，它们也会留在doctree中。
#82：确定docutils标记的依赖项的正确路径。这修复了具有依赖文件的源总是报告为已更改的行为。
识别不在部分顶层但在块项（例如表）内的toctree指令。
由于rfc.org似乎已关闭，因此使用新的RFC基本URL。
修复未定义todo项时todolist指令中的崩溃。
如果一次都没有找到LaTeX或dvipng，请不要一遍又一遍地调用LaTeX或dvipng，在这种情况下，请使用纯文本乳胶作为替代品。
修复LaTeX输出中脚注的问题。
防止双连字符在LaTeX输出中成为文本代码中的连字符。
以通用新元素模式打开文本包含文件，以允许任意新元素约定。
实际上制作 -Q 期权工作。
#86：修复toctree中的显式文档标题。
#81：以不会发生转储期间发生异常的方式编写环境和搜索索引。
#80：修复使用setlocale（）设置区域设置时的UnicodeErrors。

版本0.5.1（2008年12月15日）¶

#67：即使在静音模式下运行，也会输出有关doctest扩展中失败的doctests警告。
#72：在pngmath中，可以在Windows上提供LaTeX和dvipng的完整路径。为了实现这一目标， pngmath_latex 和 pngmath_dvipng 选项不再分为命令和附加参数;使用 pngmath_latex_args 和 pngmath_dvipng_args 以提供额外的论点。
不要在使用非ASC字符的文档测试失败时崩溃。
不要在写入包含不可编码字符的状态消息和警告时崩溃。
如果docTest扩展块不包含任何代码，请发出警告。
修复的处理 :param: 和 :type: 包含标记（尤其是交叉引用角色）的文档字段。
#65：修复pngmath扩展生成的PNG深度信息的存储。
修复在类上下文之外使用自动方法时autodoc崩溃。
#68：修复LaTeX writer输出指定高度的图像。
#60：在子目录的源中包含图像时修复错误生成的图像路径。
修复html_Copy_source关闭时的JavaScript搜索。
使用选项记录类时修复autodoc中的凹痕问题 autoclass_content = "both" 集
不要在空索引项上崩溃，只发出警告。
修复搜索JavaScript代码中的一个错字，导致某些设置中的搜索功能无法使用。

版本0.5（2008年11月23日）--生日发布！¶

新增的功能¶

标记功能：
- 引文现在是全球性的：任何文件中定义的所有引文都可以从任何文件引用。引文收集在LaTeX输出的参考书目中。
- 脚注现在在LaTeX构建器中得到了正确处理：它们出现在文本中脚注引用的位置，而不是在部分的结尾。感谢Andrew McNamara提供的初始补丁。
- “系统消息”警告现在会自动从构建文档中删除，并且仅写入stderr。如果您想要旧行为，请设置新的配置值 keep_warnings 到 True .
- 术语表条目现在会自动添加到索引中。
- 带标题的图形现在可以像部分标题一样引用，使用 :ref: 没有明确链接文本的角色。
- 添加 cmember 一致性的作用。
- 由字母或罗马数字枚举的列表现在像在标准REST中一样处理。
- 的 seealso 指令现在还可以作为简短形式给出参数。
- 现在，您可以使用新的记录多个程序及其选项 program 指令。
HTML输出和模板：
- 不兼容的更改：“根”关系链接（relbar中的左上角）现在指向 master_doc 默认情况下，不再指向名为“index”的文档。旧的行为虽然在某些情况下有用，但有些出乎意料。初始化模板中的“rootrellink”块以自定义它引用的位置。
- JavaScript搜索现在先搜索对象，然后再搜索全文。
- 目录树条目现在具有CSS类，可以根据其深度对其进行样式化。
- 突出显示的代码块现在具有CSS类，可以根据其语言对其进行样式化。
- HTML <meta> 标签通过Docutils meta 现在支持指令。
- SerializingHTMLBuilder 添加为新的抽象构建器，可以将其进行子类化以特定格式序列化构建HTML。的 PickleHTMLBuilder 是它的一个具体子集，使用pickle作为序列化实现。
- JSONHTMLBuilder 添加为另一个 SerializingHTMLBuilder 将生成的HTML转储到杨森文件中以供进一步处理的子类别。
- 的 rellinks 布局模板中的块现在被调用 linktags 以避免与relbar链接混淆。
- HTML构建器现在具有两个额外的属性，可用于禁用标题和定义链接之后的锚链接创建。
- 仅当文档中有一些模块时才生成模块索引。
新的和更改的配置值：
- 添加了对生成文本中国际化的支持 language 和 locale_dirs 配置值。非常感谢语言贡献者：
  - 霍斯特·古特曼--德国人
  - 帕维尔·科西纳--捷克人
  - 大卫·拉莱特--法国人
  - 米查菲·坎杜尔斯基--波兰人
  - Yasushi Masuda -日语
  - Guillem Borrell --西班牙人
  - 吕克·萨弗尔（Luc Saffre）和彼得·贝特尔斯（Peter Bertels）--荷兰人
  - 林弗雷德--繁体中文
  - 罗杰·德梅特雷斯库--巴西葡萄牙人
  - Rok Garbas -斯洛文尼亚人
- 新的配置值 highlight_language 为突出显示设置全局默认值。当 'python3' 选择时，控制台输出块将被识别为 'python' .
- 揭露Pygents的lexer猜测是亮点“语言” guess .
- 新的配置值 latex_elements 默认情况下，允许覆盖Sphinx放入生成的.tex文件中的所有LaTeX片段。
- 添加 exclude_dirnames 配置值，可用于从源文件搜索中排除CVS目录等。
- 添加 source_encoding 配置值来选择输入编码。
扩展：
- 新支线 sphinx.ext.jsmath 和 sphinx.ext.pngmath 为HTML和LaTeX构建者提供数学支持。
- 新的扩展 sphinx.ext.intersphinx 半自动创建指向其他项目中Python对象的Sphinx文档的链接。
- 新的扩展 sphinx.ext.todo 允许插入可以切换其在输出中可见性的“To do”指令。它还添加了一个指令来编制所有待办事项的列表。
- phinx.ext.autodoc有一个新活动 autodoc-process-signature 这允许调整函数签名内省。
- phinx.ext.autodoc有一个新活动 autodoc-skip-member 这允许调整生成的内容中包括哪些成员。
- 尊重 __all__ 自动记录模块成员时。
- 的 automodule 指令现在支持 synopsis , deprecated 和 platform 选项.
扩展API：
- Sphinx.add_node() 现在为HTML、LaTeX和文本翻译器采用可选的访问者方法;这可以避免必须手动修补类。
- 添加 Sphinx.add_javascript() 添加要加载到默认HTML模板中的脚本。
- 添加新活动： source-read , env-updated , env-purge-doc , missing-reference , build-finished .
其他变化：
- 添加了命令行开关 -Q ：它将压制警告。
- 添加了命令行开关 -A ：它可以用于向HTML模板中提供额外的值。
- 添加了命令行开关 -C ：如果给出，则没有配置文件 conf.py 是必需的.
- 添加了Distutils命令 build_sphinx ：当Sphinx安装完毕后，您可以致电 python setup.py build_sphinx 对于具有Sphinx文档的项目，该项目将构建文档并将其放置在标准Distutils构建目录中。
- 在快速启动中，如果选定的根路径已经包含Sphinx项目，请投诉并中止。

错误已修复¶

#51：逸出HTML模板中放置的配置值。
#44：修复HTML帮助索引生成中的小问题。
修复表格中行块的LaTeX输出。
#38：修复使用像素图像宽度/高度时的“非法单位”错误。
支持LaTeX输出中的表格标题。
#39：解决Jinja中导致“<generator.>的错误“将在HTML输出中发出。
修复了在LaTeX输出中未生成模块链接的问题。
修复不同目录中图像的处理。
#29：文本编写器中的支持选项列表。确保引入长选项名称的破折号不缩写为破折号。
支持HTML输出中图像的“缩放”选项。
#25：在HTML帮助属性值中正确地换掉引号。
修复某些描述环境的LaTeX构建 :noindex: .
#24：不要因角色名称的不常见而崩溃（例如 :Class: ).
仅在颜色终端上输出ANSI颜色。
更新到最新的fncycchap.sty，以修复章节标题开头的非ASCI字符的问题。
修复了LaTeX输出中由于最后未包括Hyperref而导致的索引生成问题。
不要忽视没有任何参数的函数的返回注释。
不要丢弃代码块的标签。