Sphinx1.0¶

版本1.0.8（2011年9月23日）¶

#627：修复自动摘要生成中AttateErrors的回溯。
固定 abbr 当缩写中有新元素时，角色。
#727：修复具有自定义对象类型的搜索结果的链接。
#648：修复有关未定义引用的警告中报告的行号。
#696、#666：修复不是类型名称的C++数组定义和模板参数。
#633：允许LaTeX输出中的部分标题中添加脚注。
#616：允许通过interphinx链接关键字。
#613：允许在生产列表标记名称中使用Unicode字符。
#720：为文本和人的graphviz节点添加虚拟访问者。
#704：修复图像文件重复错误。
#677：修复C++域中多个签名的解析。
#637：寻找源文件时忽略Emacs锁定文件。
#544：允许autodoc中可导入模块的.pyw扩展名。
#700：使用 $(MAKE) 在快速启动生成的Makefils中。
#734：使侧边栏搜索框宽度在浏览器中保持一致。
#644：修复HTML输出中居中数字的间距。
#767：将SphinxHelp消息打印到sys. stderrr时安全编码。
#611：修复文档中没有部分但有链接目标的LaTeX输出错误。
正确地将内置方法描述符视为autodoc中的方法。
#706：停止监视Python文本包模块。
#657：viewcode现在可以正确处理具有非ASC编码的源文件。
#669：尊重 noindex py：module指令中的flag选项。
#675：在包含不存在的行时修复IndexErrors literalinclude .
#676：尊重自定义函数/方法参数分隔符字符串。
#682：修复JS与jQuery >= 1.5的不兼容性。
#693：修复编写HTMLHelp .hhk文件时的双重编码。
#647：不要在解析文本块中应用SmartyPants。
C++域现在支持数组定义。

版本1.0.7（2011年1月15日）¶

#347：修复自动摘要中静态方法指令的错误生成。
#599：将PIL导入为 from PIL import Image .
#558：修复LaTeX输出中带有标题的长表。
使标记引用在LaTeX输出中再次用作超链接。
#572：找不到引用标签时默认显示警告。
#536：在吹毛求疵模式下抱怨缺少参考目标时，请包括卡号。
#590：修复LaTeX输出中graphviz图表的内联显示。
#589：在设置命令中使用app.build（）构建。
修复了继承图异常中的一个错误，如果其中一个基类是内置的，则会导致基类被跳过。
修复C++域对象的常规索引链接。
#332：使LaTeX输出中的警告边界可见。
#573：修复删除文件后重建时发生的KeyErrors。
修正删除带有全局指针树的文件时的回溯问题。
如果无法导入autodoc对象，请务必在下次生成时重新阅读包含指令的文档。
如果无法导入autodoc对象，请显示导入错误的完整追溯。
修复没有注意到下载文件和图像的删除的错误。
#571：实施 ~ C域的交叉引用前置。
使用#556修复LaTeX输出的回归。
#568：修复描述符上的类属性文档的查找，以便评论文档现在可以工作。
使用修复回溯 only 指令之前有目标。
修复重复C++域对象发生的回溯。
修复指向对象的JavaScript域链接， $ 以他们的名义。

版本1.0.6（2011年1月4日）¶

#581：修复Python域中空交叉引用目标的回溯。
#283：修复Chrome浏览器上的文字块显示问题。
#383，#148：支持在通用索引和词汇表中对有限范围的重音字符进行排序。
#570：尝试解码 -D 和 -A 命令行参数与区域设置的首选编码。
#528：观察 locale_dirs 在寻找JS翻译文件时。
#574：添加特殊代码以更好地支持LaTeX构建器中的日语文档。
#77的回归：如果仅给出一个参数 :param: 标记时，项目符号列表现在再次被抑制。
#556：修复某些情况下LaTeX输出中缺失的段落中断。
第567章：一个女人 autodoc-process-docstring 事件，即使对于没有文档字符串的对象也是如此，以便它可以添加内容。
#565：在LaTeX构建器中，不仅文字块需要不同的表处理，而且还有很多其他类似列表的块元素。
#515：在viewcode扩展中修复没有有效签名的Python对象的回溯。
由于Docutils版本不同，行为不同，修复包含autodo的文档字符串生成的警告的奇怪行号报告。
对C++域的几个修复。

版本1.0.5（2010年11月12日）¶

#557：为对齐的图像和图形添加Docutils 0.7所需的CSS样式。
在LaTeX输出生成的Makefile中，不要在干净时删除pdf文件;它们可能是必需的图像。
#535：修复为线块生成的LaTeX输出。
#544：允许 .pyw 作为源文件扩展名。

版本1.0.4（2010年9月17日）¶

#524：在Windows上以二进制模式打开interphinx清单，因为版本2包含zlib压缩的数据。
#513：允许为JavaScript文件提供非本地URIs，例如在JSMath扩展中。
#512：修复回溯时 intersphinx_mapping 为空.

版本1.0.3（2010年8月23日）¶

#495：修复来自Docutils目录的链接的内部链接与外部链接的区别。
#494：修复 maxdepth 选项 toctree() 与一起使用时可调用模板 collapse=True .
#507：修复解析包含字符串字面量中方括号的Python参数列表时发生的问题。
#501：使用没有标题的数字构建LaTeX文档时修复回归问题。
#510：修复不可拾取的类的继承图。
#497：为侧边栏折叠按钮引入单独的背景颜色，使其更容易看到。
#502、#503、#496：修复多个内置主题中的小布局错误。

版本1.0.2（2010年8月14日）¶

#490：修复对添加的类型对象的交叉引用 add_object_type() API函数。
修复不同指令类型的文档字段类型的处理。
允许打破长签名，继续使用避免反冲的新行。
修复C域引用不需要的样式（因为命名空间与Pygments样式冲突）。
允许引用带有明确锚点的PEP和FCC。
#471：修复LaTeX对数字的引用。
#482：进行非精确搜索时，仅匹配给定类型的对象。
#481：对Python引用目标应用非精确搜索 .name 对于模块也是如此。
#484：修复复制信息字段列表中参数时的崩溃。
#487：修复将默认角色设置为由 oldcmarkup 扩展名.
#488：修复安装json-py时崩溃的问题，它提供了一个 json 模块，但与simplejson不兼容。
#480：修复interphinx中目标命名的处理。
#486：修复删除 ! 适用于所有交叉引用角色。

Release 1.0.1（2010年7月27日）¶

#470：修复reST域对象生成的目标名称;它们不在同一命名空间中。
#266：添加孟加拉语。
#473：修复解析JavaScript对象名称时的错误。
#474：修复在没有toctree时使用SingleHTMLBuilder构建的问题。
修正intersphinx链接到的对象的显示名称。
使用SON构建器修复构建。
修复LaTeX对象描述中的超引用。

版本1.0（2010年7月23日）¶

不兼容的更改¶

已添加对域的支持。域是指令和角色的集合，它们都描述属于一起的对象，例如编程语言的元素。提供了一些内置域：
- Python
- C
- C++
- JavaScript
- reStructuredText
用于定义和链接到C指令的旧标记现在已被废弃。如果不激活 oldcmarkup 扩展;在Sphinx 1.0中，默认情况下激活。
删除了对旧依赖项版本的支持;现在的要求是：
- 文档>= 0.5
- Jinja2 >= 2.2
删除了废弃元素：
- exclude_dirs 配置值
- sphinx.builder 模块

功能添加¶

一般情况：
- 添加了“吹毛求疵”模式，对所有缺失的引用发出警告。它由 sphinx-build -n 命令行开关或 nitpicky 配置值。
- 添加 latexpdf 快速启动Makeline中的目标。
标记：
- 的 menuselection 和 guilabel 角色现在支持与和加速器。
- 现在可以识别出新的更紧凑的文档字段语法： :param type name: description .
- 添加 tab-width 选项 literalinclude 指令。
- 添加 titlesonly 选项 toctree 指令。
- 添加了 prepend 和 append 购股权予 literalinclude 指令。
- #284：所有docinfo元数据现在都被放入文档元数据中，而不仅仅是作者。
- 的 ref 角色现在还可以通过标题引用表格。
- 的 include 指令现在支持绝对路径，将其解释为相对于源目录的路径。
- 在Python领域中，引用类似 :func:`.name '现在，如果没有找到直接匹配，请查找具有任何前置的匹配名称。
配置：
- 添加 rst_prolog 配置值。
- 添加 html_secnumber_suffix 配置值用于控制部分编号格式。
- 添加 html_compact_lists 配置值来控制Docutils的紧凑列表功能。
- 的 html_sidebars 配置值现在可以包含模式作为键，并且这些值可以是显式选择应该呈现哪些侧边栏模板的列表。这意味着内置侧边栏内容只能选择性地包含。
- html_static_path 现在可以包含单个文件条目。
- 新的通用配置值 exclude_patterns 让老 unused_docs , exclude_trees 和 exclude_dirnames 不明显花瓣
- 添加 html_output_encoding 配置值。
- 添加了 latex_docclass 配置值并使“twoside”documentClass选项可由“oneside”重写。
- 添加了 trim_doctest_flags 配置值，默认为真。
- 添加 html_show_copyright 配置值。
- 添加 latex_show_pagerefs 和 ``latex_show_urls` 配置值。
- 的行为 html_file_suffix '略有更改：空字符串现在意味着“无后缀”，而不是“默认后缀”，使用 None 用于“默认后缀”。
新构建器：
- 添加了Epub格式的构建器。
- 添加了手册页面的构建器。
- 添加了单文件HTML构建器。
HTML输出：
- 内联角色现在获得一个带有其名称的CSS类，允许样式自定义其外观。特定领域的角色分为两类， domain 和 domain-rolename .
- 参考文献现在获得类 internal 如果它们是整个项目的内部，而不是当前页面的内部。
- 外部引用可以与新的不同风格 externalrefs 默认主题的主题选项。
- 在默认主题中，侧边栏现在可以实验性地使用新的 collapsiblesidebar 主题选项。
- #129：Toctree现在被包裹在 div 带有类的标签 toctree-wrapper 在HTML输出中。
- 的 toctree 模板中可调用现在有一个 maxdepth 关键字参数来控制生成的树的深度。
- 的 toctree 模板中的可调用现在接受 titles_only 关键字参数。
- 添加 htmltitle 布局模板中的块。
- 在JavaScript搜索中，允许搜索包括模块名称在内的对象名称，例如 sys.argv .
- 添加新主题 haiku Haiku OS用户指南。
- 添加新主题 nature .
- 添加新主题 agogo ，由Andi Albrecht创建。
- 添加新主题 scrolls ，由Armin Ronacher创作。
- 第193章：一个 visitedlinkcolor 主题选项切换为默认主题。
- #322：通过同步加载搜索索引来提高搜索页面的响应能力。
扩展API：
- 添加 html-collect-pages .
- 添加 needs_sphinx 配置值和 require_sphinx() 应用程序API方法。
- #200：添加 add_stylesheet() 应用程序API方法。
扩展：
- 添加了 viewcode 扩展名.
- 添加了 extlinks 扩展名.
- 添加了对autodoc中成员源排序的支持， autodoc_member_order = 'bysource' .
- 添加 autodoc_default_flags 配置值，可用于选择所有autodoc指令的默认标志。
- 为interphinx添加了一种方法，可以引用其他项目中的命名标签，并指定要链接到的项目。
- #280：Autodoc现在可以记录中分配的实例属性 __init__ 方法.
- 对 autosummary 延期，感谢Pauli Virtanen。
- #309： graphviz 扩展现在可以输出SVG而不是PNG图像，由 graphviz_output_format 配置值。
- 添加 alt 选项 graphviz 扩展指令。
- 添加 exclude 论点 autodoc.between() .
翻译：
- 感谢Bojan Mihelağe，添加了克罗地亚语翻译。
- 增加了土耳其语翻译，感谢Firat Ozgul。
- 感谢Pau Fernández，添加了加泰罗尼亚语翻译。
- 添加了简体中文翻译。
- 添加了丹麦语翻译，感谢Hjorth Larsen。
- 感谢Dalius Dobravolskas添加了立陶宛语翻译。
已修复错误：
- #445：使用由 dirhtml 建造者。
- #444：在模板中，使用“striptags”Jinja过滤器正确地重新逸出值。