Sphinx1.2

版本1.2.3（2014年9月1日发布）

功能添加

  • 一千五百一十八号： sphinx-apidoc 命令现在有 --version 显示版本信息并退出的选项

  • 新语言环境：希伯来语、欧洲葡萄牙语、越南语。

错误已修复

  • #636：LaTeX构建中的文字块中保持直接的单引号。

  • #1419：生成的i18n phinx.js文件缺少来自“.js_t”和“. html”的消息目录条目。该问题是从Sphinx 1.1中引入的

  • #1363：修复i18 n：缺少Python域与currentmode指令或currentClass指令的交叉引用。

  • #1444：自动摘要不会从属性文档字符串创建描述。

  • #1457：在python 3环境中，当链接目标url具有哈希部分时，使linkcheck导致“Can ' t convert ' bytes ' obts ' defined to char”错误。感谢Jorge_C。

  • #1467：如果自动方法指定不存在的方法，Python3就会异常

  • #1441：自动摘要无法正确处理嵌套类。

  • 第1499章：一个女人 setup 现在，在conf.py中，sphinx-Build会发出用户友好的错误消息。

  • #1502：在autodoc中，修复了包含反斜线的参数默认值的显示。

  • #1226：autodoc，autosemary：通过automotive导入 setup.py将调用设置过程并执行 sys.exit() .现在Sphinx避免了SystemExit异常并在没有意外终止的情况下发出警告。

  • #1503：py：函数指令在指定带有空列表的默认参数时生成错误的签名 [] .感谢Geert Jansen。

  • #1508：非ASCII文件名在make singlehtml，latex，man，texinfo和更改时引发异常。

  • #1531：在Python3环境中，docutils.conf中的general部分中的'source_link=true'会导致类型错误。

  • PR#270、#1533：当与继承图指令一起使用时，非ASCI文档字符串会导致UnicodeDecode错误。感谢和山四郎。

  • PR#281、PR#282、#1509：TODO扩展与网络支持不兼容。感谢小宫武。

  • #1477：gettext不会提取表或列表中的nodes.line。

  • 一千五百四十四号： make text 当表单元格为空时生成错误的表。

  • #1522：表中的脚注在LaTeX中显示两次。这个问题已经出现在Sphinx 1.2.1的#949中。

  • #508：从setup.py命令调用Sphinx时，每次退出时都以零表示。ex. python setup.py build_sphinx -b doctest 即使docTest失败也返回零。

版本1.2.2（2014年3月2日发布）

错误已修复

  • PR#211：检查是否存在时 html_logo 文件，检查完整的相对路径，而不是基本路径。

  • PR#212：使用autodoc和修复回溯 __init__ 没有文档字符串的方法。

  • PR#213：修复设置命令中缺少的导入。

  • #1357：选项名称由 option 现在再次允许不以破折号或斜线开头，并且引用它们将正确工作。

  • #1358：修复使用“收件箱”样式引用时源目录外部图像路径的处理。

  • #1374：修复如果第一行不以句点结束，自动摘要生成过长摘要的问题。

  • #1383：修复phinx-apidoc的Python 2.5兼容性。

  • #1391：实际上禁止在sphinx-quickstart中同时使用“pngmath”和“mathspel”扩展。

  • #1386：修复阻止入口点机制添加多个主题的错误。

  • #1370：忽略文本编写器中的“toctree”节点，而不是引发。

  • #1364：修复当“..”时“make gettext”失败todolist：：'指令存在。

  • #1367：修复PR#96的更改，该更改破坏了sphinx.util.docfields.Field.make_field接口/行为 item 参数使用。

文件

版本1.2.1（2014年1月19日发布）

错误已修复

  • #1335：修复带有感叹号前缀的自动摘要模板重载，如 {% extends "!autosummary/class.rst" %} 导致无限的循环函数调用。这是由PR#181引起的。

  • #1337：用修复autodoc autoclass_content="both" 使用无用 object.__init__ 类没有时的文档字符串 __init__ .这是由#1138的变更引起的。

  • #1340：无法在使用languages =' ja '生成的HTML快速搜索中搜索字母单词。

  • 第1319章：你是我的女人 html_logo 文件不存在。

  • #603：不要使用HTML化的标题来构建搜索索引（这会导致标题中有文字的每个页面上都发现“文字”）。

  • #751：使用长表允许LaTeX中的生产列表比页面长。

  • #764：在JS搜索中始终查找小写的停止词。

  • #814：autodoc：防止没有的奇怪类型对象 __bases__ .

  • #932：autodoc：如果出现，则不要崩溃 __doc__ 不是一个字符串。

  • #933：如果发生故障，请不要崩溃 option 值的格式不正确（包含空格但没有选项名称）。

  • #908：在Python 3上，在pngmath扩展中正确处理来自LaTeX的错误消息。

  • #943：在自动摘要中，如果“第一句”包含大写字母，请识别要从文档字符串中提取的。

  • #923：在缓存pngmath生成的图像时考虑整个LaTeX文档。 这会正确地重建它们时 pngmath_latex_preamble 变化

  • #901：在Sphinx数学扩展未活动的情况下使用Docutils的新“数学”标记时发出警告。

  • #845：在代码块中，当所选的lexer失败时，仍显示卡号（如果已配置）。

  • #929：正确支持LaTeX输出中的解析文本块。

  • #949：更新充满狮身X的表格。

  • #1050：添加匿名标签到 objects.inv 通过以下方式引用 intersphinx .

  • #1095：修复印刷媒体样式表始终包含在“卷轴”主题中的问题。

  • #1085：修复如果类描述有，当前类名称未设置 :noindex: 集

  • #1181：更优雅地报告autodoc指令中的选项错误。

  • #1155：修复将C定义方法自动记录为Python 3中的属性。

  • #1233：允许在interphinx中查找具有“类”和“exc”角色的Python类和异常。

  • #1198：允许“图像”作为的“figwave”选项 figure docutils记录的指令。

  • #1152：通过包含Python 2和3的两个语法版本，并为正在运行的Python版本加载适当的版本来修复Python 3代码的pycode解析错误。

  • #1017：提供帮助并告诉用户何时参数 option 与所需的格式不匹配。

  • #1345：用修复两个错误 nitpick_ignore ;现在您不必删除商店环境即可使更改生效。

  • #1072：在JS搜索中，修复了在词干之前通过大小写词搜索大写词的问题。

  • 第1299章：一个人的世界 math 指令更加一致，并避免在LaTeX输出中产生空环境。

  • #1308：在将其馈送到搜索索引器之前，从“原始”节点的内容中剥离HTML标记。

  • #1249：修复手动文档重复的LaTeX页面编号。

  • #1292：在链接检查器中，当被HTT405拒绝时，重新尝试HEAD请求。还要让重定向代码明显，并稍微调整输出以使其更加明显。

  • #1285：避免C域对象和节标题之间的名称冲突。

  • #848：始终在增量重建中使用最新的代码 sphinx.ext.viewcode 扩展名.

  • #979、#1266：修复排除处理 sphinx-apidoc .

  • #1302：修复回归 sphinx.ext.inheritance_diagram 在记录无法腌制的类时。

  • #1316：删除硬编码 font-face 来自epub主题的资源。

  • #1329：修复.po文件中使用空翻译msgstra的回溯。

  • #1300：修复某些情况下在翻译文档中不起作用的引用。

  • #1283：修复了检测已更改文件时尝试访问已删除文档的文档树的错误。

  • 1330：修复 exclude_patterns 中子目录的行为 html_static_path .

  • #1323：修复发射空 <ul> HTML编写器中的标签，该标签不是有效的HTML。

  • #1147：不要在“singlehtml”生成器中发出侧边栏搜索框。

文件

  • #1325：添加了“Interphinx”教程部分。 (doc/tutorial.rst )

版本1.2（2013年12月10日发布）

功能添加

  • 添加 sphinx.version_info 用于对Sphinx版本进行编程检查的tuple。

不兼容的更改

  • 删除了 sphinx.ext.refcounting 扩展--它非常特定于CPython，并且在主发行版中没有位置。

错误已修复

  • 恢复 versionmodified 已添加/更改和不建议使用的版本指令的CSS类。

  • PR#181：修复 html_theme_path = ['.'] 始终是重建所有文档的触发器（此更改保留了当前的“主题更改导致重建”功能）。

  • #1296：修复HTML帮助为默认区域设置生成的HTML文件中的无效字符集。

  • PR#190：修复gettext不提取其他块内的图形标题和标题。感谢迈克尔·施伦克。

  • PR#176：确保set_call测试始终可以导入Sphinx。感谢德米特里·沙赫涅夫。

  • #1311：修复测试_linkcode.Test_html在C locale和Python 3中失败的问题。

  • #1269：使用Python 3.2或更高版本修复资源库。

  • #1138：修复：何时 autodoc_docstring_signature = True 和 autoclass_content = 'init' 或 'both' , __init__ 应从类文档中删除行。

版本1.2 beta3（2013年10月3日发布）

功能添加

  • Sphinx错误日志文件现在将包括已加载的扩展列表，以帮助调试。

不兼容的更改

  • PR#154：从LaTeX Class名称中删除“phinxmanual”和“phinxhowto”除外的“phinxhowto”。现在您可以使用不带“phinx”前置的自定义文档类。感谢埃里克·B。

错误已修复

  • #1265：修复翻译指定目标指向的节名称时i18 n：崩溃。

  • 错误的条件破坏了第一页（通常为index.rst）的搜索功能。 此问题在1.2b1中引入。

  • #703：当Sphinx无法解码包含非ASC字符的文件名时，Sphinx现在会捕获UnicodeMessage，并在可能的情况下继续，而不是引发异常。

版本1.2 beta2（2013年9月17日发布）

功能添加

  • apidoc 现在默认忽略“_private”模块，并有一个选项 -P 包括他们。

  • apidoc 现在可以选择不为包和模块生成标题，因为模块文档字符串已经包含reST标题。

  • PR#161： apidoc 现在可以将每个模块写入独立页面，而不是将包中的所有模块合并到一个页面上。

  • 构建者：更新目录时重建i18 n目标文档。

  • 支持HTML writer中的docutils. inf“writers”和“html4css1 writer”部分。 latex、manpage和texinfo作家也支持各自的“作家”部分。

  • 新 html_extra_path 配置值允许指定包含应直接复制到HTML输出目录的文件的目录。

  • 模块数据和属性的Autodoc指令现在支持 annotation 选项，以便可以覆盖数据/属性值的默认显示。

  • PR#136：Autodoc指令现在支持 imported-members 选项包括从不同模块导入的成员。

  • 新地点：马其顿语、僧加罗语、印度尼西亚语。

  • 使用setuptools插件机制进行主题包集合。

不兼容的更改

  • PR#144、#1182：在gettext builder生成的POT-Creation-Date上将时区偏差强制到LocalTimeZone。感谢Masklinn和Jakub Wilk。

错误已修复

  • PR#132：更新jQuery版本到1.8.3。

  • PR#141、#982：使用Python 3编写PNG文件时避免崩溃。感谢Marcin Wojdyr。

  • PR#145：在并行构建中，Sphinx删除了第二个要写入的文档文件。感谢tychoish。

  • PR#151：LaTeX中表格的一些样式更新。

  • PR#153：现在可以覆盖“extensions”配置值。

  • PR#155：添加了对一些C++11函数限定符的支持。

  • 修复：当模板包含utf-8编码字符串时，“make gettext”导致UnicodeDecode错误。

  • #828：使用inspect.getfullargspec（）能够在Python 3上记录具有仅关键字参数的函数。

  • #1090：修复i18 n：同一行中的多个交叉引用（term、ref、Doc）返回相同的链接。

  • #1157：“globaltoc.html”和隐藏的toctree的组合导致异常。

  • #1159：修复Python模块的对象清单的错误生成，并在interphinx中添加解决办法以修复受影响清单的处理。

  • #1160：引文目标缺失导致Assertion错误。

  • #1162、PR#139：singlehtml构建器没有将图像复制到_images/。

  • #1173：调整setup.py依赖项，因为Jinja 2 2.7不再与Python < 3.3和Python < 2.6兼容。 感谢亚历山大·杜普伊。

  • #1185：当Python模块声明了错误的编码或未声明编码并且包含非ASC字符时，不要崩溃。

  • #1188：如果“项目版本”包括非ASCI字符，phinx-quickstart会引发UnicodeEncodeMessage错误。

  • #1189：“标题下线太短”在快速启动上使用全宽字符时，会给出“标题下线太短”。

  • #1190：当快速启动的“项目名称”中使用非ASCI字符时，输出TeX/texinfo/man文件名没有基本字符（只有扩展名）。

  • #1192：修复手册页编写器中超链接的逸出问题。

  • #1193：修复i18 n：同一行中的多个链接引用返回相同的链接。

  • #1176：修复i18 n：自动编号命名脚注和自动符号脚注的脚注参考号缺失。

  • PR#146，#1172：修复并行构建中的ZeroDivision错误。感谢tychoish。

  • #1204：修复指向本地interphinx目标的链接的错误生成。

  • #1206：修复i18 n：gettext没有翻译警告指令的标题。

  • #1232：Sphinx在Windows上生成了损坏的ePub文件。

  • #1259：发出事件时保护调试输出调用;防止任意对象的repr（）实现导致构建失败。

  • #1142：修复Mac OS X上rst文件名的NFC/NFD规范化问题。

  • #1234：忽略仅由空白字符组成的字符串。

版本1.2 beta1（2013年3月31日发布）

不兼容的更改

  • 移除 sphinx.util.compat.directive_dwim() 和 sphinx.roles.xfileref_role() 这些自1.0版本以来就被废弃了。

  • PR#122：中给出的文件 latex_additional_files 现在覆盖Sphinx包含的TeX文件，例如 sphinx.sty .

  • PR#124：由生成的节点 versionadded , versionchanged 和 deprecated 指令现在包括所有添加的标记（例如“X版中的新建”）作为子节点，并且编写者不必生成任何额外的文本。

  • PR#99： seealso 指令现在生成警告节点而不是自定义 seealso node.

功能添加

  • 标记

    • 的 toctree 指令和 toctree() 模板函数现在有一个 includehidden 包含隐藏的toctree条目（错误#790和#1047）的选项。 中的一个错误 maxdepth 选项 toctree() 模板功能已修复（错误#1046）。

    • PR#99：剥去正常警告的指令。 这删除了它们不寻常的CSS类（警告-参见-also）、不一致的LaTeX警告标题（“See Also”而不是“See also”）以及文本生成器中的虚假凹痕。

  • HTML构建器

    • #783：如果按宽度或高度缩放，则创建一个到全尺寸图像的链接。

    • #1067：改进JavaScript搜索结果的顺序：标题中的匹配先于全文匹配，并且对象结果得到了更好的分类。 还实现可插入的搜索评分器。

    • #1053：“rightsidebar”和“visible sidebar”HTML主题选项现在可以一起使用。

    • 更新到jQuery 1.7.1和Underscore.js 1.3.1。

  • Texinfo构建者

    • 当没有条目时，不再添加“索引”节点。

    • 如果“defn”类别包含大写字母，则不再大写。

    • desc_annotation 现在已渲染节点。

    • strong 和 emphasis 节点现在的格式如下 literal s。这是因为标准的Texinfo标记 (*strong* 和 _emphasis_ ）导致了混乱的输出，因为通常使用这些构造来记录参数名称。

    • 字段列表格式已进行调整，以更好地显示“信息字段列表”。

    • system_message 和 problematic 现在，节点的格式与文本生成器类似。

    • 选项指令签名中不再执行连字符的“en-dash”和“em-dash”转换。

    • @ref 现在使用而不是 @pxref 用于交叉引用，防止在链接之前添加“查看”一词（不影响Info输出）。

    • 的 @finalout 已添加命令以获得更好的TeX输出。

    • transition 现在，节点的格式使用引号（“_”）而不是星号（“*”）。

    • 的默认值 paragraphindent 已从2更改为0，这意味着默认情况下段落不再是缩进的。

    • #1110：新配置值 texinfo_no_detailmenu 已添加用于控制是否 @detailmenu 添加到“Top”节点的菜单中。

    • 除“Top”节点外，不再创建详细菜单。

    • 修复了重复的域索引会导致无效输出的问题。

  • LaTeX制造商：

    • PR #115：添加 'transition' 项目 latex_elements 用于自定义过渡的显示方式。感谢Jeff Klukas。

    • PR#114：LaTeX编写器现在默认包含“cmap”包。的 'cmappkg' 项目 latex_elements 可以用来控制它。感谢德米特里·沙赫涅夫。

    • 的 'fontpkg' 项目 latex_elements 现在默认为 '' 当 language 使用西里尔字母。 由德米特里·沙赫涅夫建议。

    • 的 latex_documents , texinfo_documents ，而且 man_pages 配置值将根据 master_doc 如果没有显式设置 conf.py .以前，如果未设置这些值，则各自的构建者不会生成任何输出。

  • 国际化：

    • 为自定义模板添加i18 n功能。 例如：Doc目录中的Sphinx参考文档提供了 sphinx.pot 包含消息字符串的文件 doc/_templates/*.html 当使用 make gettext .

    • PR#61，#703：添加对非ASC文件名处理的支持。

  • 其他构建器：

    • 添加了Docutils原生的ML和伪ML构建器。 看到 XMLBuilder 和 PseudoXMLBuilder .

    • PR#45：链接检查构建器现在检查 #anchor s的存在。

    • PR#123、#1106：添加 epub_use_index 配置值。 如果提供，将使用它而不是 html_use_index 对于epub建设者。

    • PR#126：添加 epub_tocscope 配置值。该设置控制epub toc的生成。用户现在还可以包含隐藏的toc条目。

    • PR#112：添加 epub_show_urls 配置值。

  • 扩展：

    • PR#52： special_members autodoc标志现在的行为类似于 members .

    • PR#47：添加 sphinx.ext.linkcode 扩展名.

    • PR#25：在继承关系图中，类文档字符串的第一行现在是类的工具提示。

  • 命令行界面：

    • PR#75：添加 --follow-links sphinx-apidoc选项。

    • #869：狮身X-构建现在可以选择 -T 用于在未处理的异常后打印完整的追溯。

    • phinx-Build现在支持该标准 --help 和 --version 选项.

    • 当使用无效选项或参数调用时，phinx-Build现在提供更具体的错误消息。

    • phinx-Build现在有一个详细选项 -v 可以重复进行以获得更大的效果。 单次出现会提供比正常情况稍微详细的输出。 此选项出现两次或多次可提供更详细的输出，这可能对调试有用。

  • 地区：

    • PR#74：修复一些俄语翻译。

    • PR#54：添加了挪威语博克马尔翻译。

    • PR#35：添加了斯洛伐克语翻译。

    • PR#28：添加了匈牙利语翻译。

    • #1113：添加希伯来语区域设置。

    • #1097：添加巴斯克地区。

    • #1037：修复波兰语翻译中的错别字。感谢雅库布·威尔克。

    • #1012：更新爱沙尼亚语翻译。

  • 优化：

    • 通过缓存词干提取例程的结果来加快构建搜索索引的速度。 在构建Python文档时花费大约20秒。

    • PR#108：通过新的并行构建添加实验支持 sphinx-build -j 选项.

文件

  • PR#88：添加了“Sphinx开发人员指南” (doc/devguide.rst ），概述了狮身星项目的基本开发过程。

  • 添加了详细的“安装Sphinx”文档 (doc/install.rst ).

错误已修复

  • PR#124：修复当没有悬挂段落时，versionmodified中的段落被忽略。 修复错误的html输出（嵌套 <p> 标签）。 修复版本修改后不可翻译。 感谢Nozomu Kaneko。

  • PR#111：即使设置了继承成员，也要尊重add_autodoc_attrgetter（）。感谢A。杰西·吉柳·戴维斯。

  • PR#97：修复翻译文档中的脚注处理。

  • 修复文本编写器不处理图形指令内容的visit_legend。

  • 修复文本生成器不尊重宽/全宽字符的问题：标题下线宽度、表格布局宽度和文本迂回宽度。

  • 修复LaTeX表格标题单元格中的领先空间。

  • #1132：修复第一列中多行单元格的LaTeX表输出。

  • #1128：修复尝试使用非标准区域设置格式化时间字符串时的Unicode错误。

  • #1127：修复autodoc尝试对非Python文件进行标记化时的回溯。

  • #1126：修复错误位置（例如LaTeX中的命令行选项名称）中的双连字符到破折号的转换。

  • #1123：允许给予的文件名中有空白 literalinclude .

  • #1120：增加了关于Sphinx内置主题“基本”，“俳句”和“卷轴”的i18n的改进。感谢Leonardo J. Caballero G.

  • #1118：更新西班牙语翻译。感谢Leonardo J. Caballero G.

  • #1117：在sphinx-apidoc中处理.pyx文件。

  • #1112：以不同方式（绝对/相对）从文档中引用时避免重复下载文件。

  • #1111：修复在搜索中找不到收件箱单词时 html_search_language 是“雅”感谢Tomo Saito。

  • #1108：文本编写器现在正确地对具有非默认开始值的列举列表进行编号（基于Ewan Edwards的补丁）。

  • #1102：支持autodoc中的多上下文“with”陈述。

  • #1090：修复gettext不提取术语表术语的问题。

  • #1074：将环境版本信息添加到生成的搜索索引中，以避免与旧版本的兼容性问题。

  • #1070：运行Python 3时避免解pickle问题，并且保存的环境是在Python 2下创建的。

  • #1069：修复了autodoc尝试在没有关键字参数的情况下格式化“部分”函数的签名时引起的错误（由Artur Gaspar补丁）。

  • #1062：phinx.ext.autodoc使用 __init__ 类签名的方法签名。

  • #1055：修复Web支持与源目录的相对路径。

  • #1043：修复Sphinx快速启动再次询问是/否问题，因为 input() 在Python 3.2.0 + Windows上返回带有额外“r”的值。感谢雷吉斯·德坎普斯。

  • #1041：修复cpp域解析器无法解析带有修饰符的const类型。

  • #1038：修复cpp域解析器无法解析C+11“静态constexpr”声明。 感谢雅库布·威尔克。

  • #1029：修复如果映射具有Python 3.3设置的复数键/值，interphinx_mapping值不稳定的问题。

  • #1028：修复文本生成器中的行块输出。

  • #1024：如果找不到Sphinx，则改进Makefile/make.mat错误消息。感谢Anatoly Techtonik。

  • #1018：修复文本生成器中的“容器”指令处理。

  • #1015：停止在JavaScript中重写jQuery contains（）。

  • #1010：默认情况下使pngmath图像透明; IE7+应该处理它。

  • #1008：用Python 3.3修复测试失败。

  • #995：修复LaTeX“howto”类的目录和页码。

  • #976：修复gettext不提取索引条目。

  • PR#72：#975：修复了gettext未提取Docutils 0.10之前的定义项的问题。

  • #961：修复代码片段中三重引号的LaTeX输出。

  • #958：不要保存 environment.pickle 在失败的构建之后。

  • #955：修复i18 n转换。

  • #940：修复gettext不提取图形标题。

  • #920：修复允许进口的PIL包装问题 Image 没有PIL命名空间。 感谢马克·施莱奇。

  • #723：修复基于WebKit的浏览器中本地文件的搜索功能。

  • #440：修复某些文件系统中粗糙的时间戳解析，生成错误的过时文件列表。