Sphinx1.5¶
版本1.5.6（2017年5月15日发布）¶
错误已修复¶
#3614：Sphinx crashes with requests-2.5.0
#3618：autodoc因二元参数崩溃
#3664：Sphinx制作的乳胶列表中的项目中项目符号后面没有空白
#3657：如果存在以genindex开头的文档，EPub生成器就会崩溃
#3588：i18 n文档构建中也没有紧凑（p标签）html输出，即使在
html_compact_lists是True.#3685：使用第三方域时发生Attate错误
#3702：LaTeX作家用硬编码来风格人物传奇
\small#3708：LaTeX writer allows irc scheme
#3717：停止强制favicon必须是.ico
#3731、#3732：保护isSYS类断言免受非类参数的影响
#3320：关于找不到容器类型的引用目标的警告
Latex构建库的Makefile中拼写错误的ARCHIVEPREFIX
版本1.5.5（2017年4月3日发布）¶
错误已修复¶
#3597：如果给出的名称无效，Python域将引发UnboundLocal错误
#3599：转移到新的MathJax CDO
版本1.5.4（2017年4月2日发布）¶
功能添加¶
#3470：让genindex支持所有类型的字母，而不仅仅是拉丁字母
错误已修复¶
#3445：设置
'inputenc'关键\\usepackage[utf8x]{inputenc}导致PDF构建失败EPub文件已复制
nav.xhtml环节content.opf除了第一次建造#3488：opports.inv已损坏时
release或version包含返回代码#2073、#3443、#3490：gettext构建器，用于写入pot文件，除非内容相同且没有创建日期。感谢Shibuawa Yoshiki。
#3487：interphinx：未能引用选项
#3496：乳胶长表的最后一列可能比其内容广泛得多
#3507：productionlist指令的乳胶输出中的引用错误
#3533：从Sphinx 1.3.1移至1.5.3打破了LaTeX将链接渲染为代码的编译
#2665、#2607：链接C++文档字段中的名称，并使其能够用于其他域。
#3542：C++，修复非类型模板参数与模板的解析错误。
#3065、#3520：Python域无法识别嵌套类
#3575：使用Sphinx构建的土耳其文档中pdflatex的问题再次出现（参考#2997、#2397）
#3577：修复interphinx调试工具
LaTeX命令，例如
\\large插入的标题项latex_documents导致PDF构建失败（参考文献#3551，#3567）
版本1.5.3（2017年2月26日发布）¶
功能添加¶
支持请求-2.0.0（实验性）（参考：#3367）
（乳胶）PDF页面页边空白尺寸可以定制（参考文献：#3387）
literalinclude指令允许组合:pyobject:和:lines:选项（参考文献：#3416）#3400：make-mode不使用构建文档的子流程
错误已修复¶
#3370：代码块的标题未被拾取进行翻译
LaTeX：
release未逃脱（参考文献：#3362）#3364：sphinx-quickstart在控制台上提示溢出，宽度为80个字符
自1.5以来，PDF的目录和书签缺乏一般索引的条目（参考文献：#3383）
#3392：
'releasename'在latex_elements不工作#3356：日语页面布局
'manual'docClass的文本区域更短#3394：何时
'pointsize'不10pt、日本人'manual'文档的PDF页面尺寸错误#3399：快速启动：conf.py未被模板覆盖
#3366：选项指令不允许标点符号
#3410：返回代码
release打破html搜索#3427：autodoc：Windows上不会剥离内存地址
#3428：xetex构建测试因fontspec v2.6定义而失败
\strong#3349：结果
IndexBuilder.load()坏了#3450：& nbsp出现在EPub文档中
#3418：搜索按钮本质和金字塔主题不一致
#3421：无法翻译表格的标题
#3552：linkcheck引发UnboundLocal错误
版本1.5.2（2017年1月22日发布）¶
不兼容的更改¶
相关要求更新：要求2.4.0或更高版本（参考：#3268，#3310）
功能添加¶
#3241：如果标题有缺陷，则发出乳胶警告ec（参考#3210）
#3194：参考$MAKE环境变量来确定
make命令对嵌套编号的toctree发出警告（参考文献：#3142）
#978：
intersphinx_mapping还允许列表作为参数#3340：（LaTeX）排长队 parsed-literal 被包裹得像
code-block、内联数学和脚注功能齐全。
错误已修复¶
#3246：xapian搜索适配器崩溃
#3253：在Py2环境中，使用无标题toctree构建另一个区域设置会产生
None字幕#185：对包含原始节点的部分标题的引用已损坏
#3255：在Py3.4环境中，autodoc不支持正确记录Enum类的属性。
#3261：
latex_use_parts让狮身克斯坠毁警告类型
misc.highlighting_failure不起作用#3294：
add_latex_package()非LaTeX制造商制造崩溃表标题呈现为无效的HTML（参考文献：#3287）
#3268：Sphinx因Debian jessie的请求包而崩溃
#3284：Sphinx在并行构建时崩溃，扩展会引发不可序列化异常
#3315：参考书目因docClass“回忆录”而崩溃
#3328：无法隐式引用标题
#3329：如果po文件无效并且无法读取，则发出警告。还写mo
#3337：定义列表项分类器的丑陋渲染
#3335：gettext不会提取field_list中字段的field_名称
#2952：C++，修复operator（）函数的引用。
修复中的Unicode超位和下标位
code-block和解析文本LaTeX输出（参考#3342）LaTeX作家：离开
"解析文本内的字符按原样（参考#3341）#3234：interphinx编码库存失败
#3158：PDF输出中的字幕后面空间太大
#3317：如果带有连字符，解析文本内容中的URL将在PDF中错误呈现
如果通过替换插入解析文本中的图像的文件名包含连字符（ref #3340），LaTeX就会崩溃
LaTeX在解析文本中插入脚注的渲染错误（参考#3340）
LaTeX没有很好地呈现解析文本中的内联数学（参考#3340）
#3308：Parsed-literals don't wrap very long lines with pdf builder（参考#3340）
#3295：无法导入扩展phinx.builders.linkcheck
#3285：自动摘要：星号被逸出两次
LaTeX，将dvipdfm选项传递给日本文档的几何包（参考#3363）
Fix parselinenos（）无法解析左半开放范围（参见“-4”）
版本1.5.1（2016年12月13日发布）¶
功能添加¶
#3214：允许使用禁止epub构建器发出的“未知mimetype”警告
suppress_warnings.
错误已修复¶
#3195：无法并行构建
#3198：当toctree有'self'时会引发AttributeError
#3211：删除未翻译的Sphinx语言环境目录（未翻译的it_IT涵盖了该目录）
#3212：HTML Builders crashes with Docutils 0.13
#3207：解析字面指令中引用的更多乳胶问题 (
\DUrole)#3205：sphinx.util.requests crashes with old pyOpenSSL（< 0.14）
#3220：具有重复引用时出现键错误
#3200：LaTeX：desc_Name内的xref不允许
三二二八：
build_sphinx缺少依赖项时命令崩溃#2469：忽略gettext生成器的目录文件的更新。感谢Hiroshi Ohkubo。
#3183：生成的索引页面中随机跳转框顺序。
版本1.5（2016年12月5日发布）¶
不兼容的更改¶
1.5a1
latex，fancybox包不再是sphinx的依赖项。sty
使用
'locales'作为默认值locale_dirs乳胶，包如果then不再是sphinx.sty的依赖项
latex，样式文件不会修改fancyvrb的Verbatim（也可用作OriginalVerbatim），但使用sphinxVerbatim作为自定义包装器的名称。
乳胶，包装newfloat不再使用（也不包括在内）（参考#2660;自1.3.4以来一直使用，并自1.4以来与Sphinx一起运输）。
表格中的latex、文字块不使用OriginalVerbatim，而是使用处理字幕和包装行的sphinxVerbatimintable（参考#2704）。
乳胶，更换
pt由TeX等效物bp如果发现width或height图像的属性。乳胶，如果
width或height图像的属性没有单位给出，使用px而不是忽视它。latex：将paggement的单独样式表保存到独立的.sty文件
#2454：sourcelink的文件名现已更改。 的价值
html_sourcelink_suffix将附加到原始文件名（例如index.rst.txt).sphinx.util.copy_static_entry()现在已被废弃。使用sphinx.util.fileutil.copy_asset()而不是.sphinx.util.osutil.filecopy()如果文件未更改，则跳过复制（参考：#2510，#2753）Internet Explorer 6-8，Opera 12.1x或Safari 5.1+支持被删除，因为jQuery版本从1.11.0更新到3.1.0（参考：#2634，#2773）
QtHelpBuilder不生成搜索页面（参考：#2352）
QtHelpBuilder使用
nonav主题而不是默认主题以提高可读性。乳胶：为了为日语文档提供良好的默认设置，Sphinx使用
jreport和jsbook作为docClass，如果language是ja.sphinx-quickstart现在允许项目版本为空修复：下载：epub/qthelp构建器上的角色。他们忽视了这个角色，因为他们不支持它。
sphinx.ext.viewcode默认情况下不适用于epub构建。viewcode_enable_epub选项sphinx.ext.viewcode在singlehtml构建器上禁用。使用制作模式
sphinx-quickstart在默认情况下 要禁用此功能，请使用-M选项修复
genindex.html，Sphinx的文档模板，链接地址到自己以满足xhtml标准。默认使用epub 3构建器。 旧的epub构建器更名为epub 2。
修复
epub和epub3包含链接的构建器genindex即使epub_use_index = False.html_translator_class现在已被废弃。使用set_translator()API代替。放弃Python 2.6和3.3支持
删除epub 3构建者的
epub3_page_progression_direction选项（使用epub3_writing_mode).#2877：
latex_elements['footer']到latex_elements['atendofbody']
1.5a2
#2983：
epub3_description和epub3_contributor到epub_description和epub_contributor.删除themes/basic/definex.html;不再使用
Sphinx不再发布（但仍然使用）LaTeX风格文件
fncychap#2435：瘦身快速启动conf.py
的
sphinx.sty乳胶包不会加载自己“Hyperref”，这在乳胶输出的序言部分后面通过'hyperref'钥匙Sphinx不再提供自定义修改的LaTeX风格文件
tabulary.使用未修改的包。#3057：默认情况下，乳胶PDF输出中的脚注标记前面不再有空白，
\sphinxBeforeFootnote如果需要，允许用户定制。LaTeX目标需要该选项
hyperfootnotes包装hyperref保持不变，直至默认状态（即true）（参考文献：#3022）
1.5最终
#2986：
themes/basic/defindex.html现已弃用默认情况下，发出在Sphinx 1.6中不建议使用的警告。用户可以通过设置环境变量PYTHONWARNINGS来更改行为。请参阅 不推荐使用警告 .
#2454：新的JavaScript变量
SOURCELINK_SUFFIX添加
弃用¶
这些功能已在Sphinx 1.6中删除：
i18 n功能中的LDML格式支持
sphinx.addnodes.termsep中的一些函数和类
sphinx.util.pycompat:zip_longest,product,all,any,next,open,class_types,base_exception,relpath,StringIO,BytesIO.请改用标准库版本;
如果任何弃用警告，如 RemovedInSphinxXXXWarning 显示，请参阅 不推荐使用警告 .
功能添加¶
1.5a1
#2951：添加
--implicit-namespaces对apidoc的PEP-0420支持。添加
:caption:sphinx.ext.继承_diagram的选项。#2471：添加默认docTest标志的配置变量。
将linkcheck生成器转换为请求以更好地编码处理
#2463、#2516：将“Meta”指令的关键字添加到搜索索引
:maxdepth:toctree选项影响secnumdepth(ref：#2547）#2575：现在
sphinx.ext.graphviz允许:align:选项如果将未知键指定为
latex_elements如果没有域名匹配，则显示警告
primary_domain(ref：#2001）C++，当角色类型对其引用的目标类型具有误导性时，显示警告（例如，使用
class功能的角色）。latex，writer将更多文本样式抽象为可定制宏，例如
visit_emphasis将输出\sphinxstyleemphasis而不是\emph（它可能在其他地方或添加的LaTeX包中使用）。请参阅结尾的列表sphinx.sty(ref：#2686）乳胶、注释、警告和其他警告类型使用的环境和参数的公共名称，允许从
'preamble'键或输入文件（参考：功能请求#2674、#2685）latex，更好地计算某些表格的列宽（因此，由于表格现在正确填充了行宽，因此会有轻微变化;参考号：#2708）
乳胶、phinxVerbatim环境更容易定制（参考号：#2704）。除了现有的VerbatimColor和VerbatimBorderColor之外：
两个长度
\sphinxverbatimsep和\sphinxverbatimborder,布尔值
\ifsphinxverbatimwithframe和\ifsphinxverbatimwrapslines.
乳胶、表内文字块的标题得到处理，长代码行包装以适合表单元格（参考号：#2704）
#2597：警告消息显示为深红色
乳胶，允许使用px单位进行图像尺寸（默认为96 px = 1英寸）
如果发现无效维度单位，则显示警告
#2650：添加
--pdbsetup.py命令的选项乳胶，利用
\small用于可定制的代码列表（参考#2721）#2663：添加
--warning-is-errorsetup.py命令的选项如果使用废弃乳胶选项，则显示警告
添加phinx. connect.ENUM以检查候选项中的配置值
数学：将超链接标记添加到HTML输出中的每个方程
添加新主题
nonav这不包括任何导航链接。这适用于任何像qthelp这样的帮助生成器。#2680：
sphinx.ext.todo现在会发出警告，如果todo_emit_warnings启用.此外，它还发出一个名为todo-defined处理第三方扩展中的TODO条目。Python域签名解析器现在将xref混合用于“异常”，允许自动链接异常类。
#2513：添加
latex_engine通过conf.py切换LaTeX引擎#2682：C++，对属性的基本支持（C++11风格和GNU风格）。新的配置变量'cpp_id_attributes'和'cpp_paren_attributes'可用于引入自定义属性。
#1958：C++，添加配置变量“cpp_index_common_predict”，用于从C++对象的索引文本中删除前置符。
C++，增加了概念指令。感谢mickk-on-cpp。
C++，添加了对模板引入语法的支持。感谢mickk-on-cpp。
#2725：乳胶构建器：允许使用用户定义的模板文件（实验性）
apidoc现在可以通过不写入内容未更改的文件来避免使缓存文件无效。如果频繁运行apidoc，这可能会带来显着的性能胜利。
#2851：
sphinx.ext.math如果未找到公式，则发出缺少引用事件#1210：
eqref角色现在支持交叉引用#2892: Added
-a(--append-syspath) option tosphinx-apidoc#1604：epub 3构建器：在iBooks中查看时遵守与字体相关的CSS。
#646：
option指令支持'。“性格作为选项的一部分添加有关kindlegen的文档并修复其文档结构。
#2474：添加
intersphinx_timeout选项sphinx.ext.intersphinx#2926：EPub 3构建器支持垂直模式 (
epub3_writing_mode选项）#2695：
build_sphinxsetuptools的子命令处理异常的方式与sphinx-build并#326：
numref角色还可以参考部分二九一六号：
numref角色还可以将标题称为其链接文本
1.5a2
三千零八号：
linkcheck构建器忽略自签名证书URL#3020：新的
'geometry'关键latex_elements其默认使用LaTeX风格文件geometry.sty设置页面布局#2843：将：start-at：和：end-at：选项添加到文本包含指令
#2527：添加
:reversed:toctree指令的选项添加
-t和-d选项sphinx-quickstart以支持模板生成的Sphinx项目。#3028：添加
{path}和{basename}的格式figure_language_filename新
'hyperref'钥匙latex_elements词典（参考#3030）#3022：允许LaTeX PDF输出脚注中的代码块
1.5b1
#2513：一个更好的XeLaTeX默认设置
#3096：
'maxlistdepth'解决LaTeX列表限制的关键#3060：autodoc支持Enum类属性的文档。现在autodoc只呈现Enum属性的值，而不是Enum属性表示。
添加
--extensions到sphinx-quickstart支持从命令行启用任意扩展（参考号：#2904）#3104、#3122：
'sphinxsetup'用于Sphinx LaTeX的键=值样式#3071：Autodoc：允许模仿的模块装饰器不改变传递函数
#2495：linkcheck：允许使用跳过锚点检查
linkcheck_anchors_ignore#3083：让Unicode不间断空格像LaTeX一样
~（已修复#3019）#3116：允许在PDF输出中对内联字面量进行自动绕字处理（参考#3110）
#930：phinx-apidoc允许用外卡排除路径。感谢尼克·科格兰。
#3121：添加
inlineliteralwraps用于控制是否以乳胶形式进行内联文字自动包装的选项
1.5最终
#3095：添加
tls_verify和tls_cacerts支持linkcheck和interphinx中的自签名HTTPS服务器#2215：可以从另一个目录调用由spinx-quickstart生成的make. mat。感谢蒂莫西·坎皮克。
#3185：添加新警告类型
misc.highlighting_failure
错误已修复¶
1.5a1
#2707：（乳胶）表格的列宽计算得很糟糕
#2799：Sphinx在导入Sphinx模块时自动安装角色和指令。 现在Sphinx将它们安装在正在运行的应用程序上。
sphinx.ext.autodoc如果目标代码从模拟模块导入 *，则崩溃autodoc_mock_imports.1953年：
Sphinx.add_node不添加安装翻译器的处理程序html_translator_class#1797：文本生成器在顶部插入白线
#2894：quickstart main（）不使用argv参数
#2874：gettext生成器无法提取下的所有文本
only指令#2485：自动摘要崩溃，有多个source_suffix值
#1734：无法翻译toctree指令的标题
无法翻译Meta指令的内容（参考号：#1734）
#2550：在帮助查看器中打开外部链接
#2687：多次运行Sphinx会产生“已注册”警告
1.5a2
#2810：意大利文档中pdflatex的问题
使用
latex_elements.papersize在Makefile中指定LaTeX的纸张大小#2988：linkcheck：如果HEAD请求被拒绝，则重新尝试GET请求
#2990：如果linkcheck_anchors启用，linkcheck会引发“Can t t contrate ' bytes '对象intentially转换为字符串”错误
#3004：使用了无效的链接类型“top”和“up”
#3009：自Sphinx 1.4.4以来，LaTeX中解析文本的渲染不佳
#3000：
option指令生成无效的HTML锚点#2984：如果出现以下情况，则生成无效的HTML
html_split_index启用#2986：themes/basic/definex.html应更改为html5友好型
#2987：如果将多个ID分配给列表，则生成无效的HTML
#2891：HTML搜索不提供所有结果
#1986：PDF输出中的标题
#147：乳胶章节风格的问题
#3018：页面布局维度和章节标题的LaTeX问题
修复与的问题
\pysigline在LaTeX风格文件中（参考#3023）#3038：
sphinx.ext.math*如果标签重复，则会引发TypHelp#3031：与LaTeX包不兼容
tocloft#3003：Latex不支持脚注中的文字块
#3047：pdf输出中脚注前的间距不一致，允许中断
#3045：HTML搜索索引创建者应该忽略“原始”内容，如果现在html
#3039：如果单词大写，英语词干分析器将返回错误的单词
修复制作模式Makefile模板（参考#3056、#2936）
1.5b1
#2432：修复varargs和仅关键字args之间不需要的 *。感谢Alex Grönholm。
#3062：无法使用1.5a2构建PDF（未定义
\hypersetup自PR#3030以来的日本文件）在html中更好地呈现多行签名。
#777：LaTeX输出“嵌套太深”（参考#3096）
让LaTeX图像包容性服从
scale文本宽度匹配之前（参考#2865、#3059）#3019：LaTeX在描述带有参数的C函数时失败（参考#3083）
修复乳胶内联文字，其中
< > -霸占了一个空间
1.5最终
#3069：即使
'babel'键设置为空字符串，LaTeX输出包含一个\addto\captions...#3123：用户
'babel'不再遵守按键设置#3155：修复JavaScript
html_sourcelink_suffixIE和歌剧失败#3085：破坏构建文档后保留当前目录。感谢蒂莫西·坎皮克。
#3181：pLaTeX崩溃，部分包含endash
#3180：乳胶：在连续的单线或多线cpp签名之间添加拉伸/收缩（参考#3072）
#3128：环球图像不支持.svgz文件
#3015：修复Windows上损坏的测试。
#1843：修复具有自定义元类的描述符类的文档。感谢埃里克·布雷。
#3190：util.split_docinfo无法解析多行字段体
#3024、#3037：在Python3中，application.Sphinx._当日志消息无法编码为控制台编码时，日志会被压碎。
测试¶
为了简化，Sphinx使用外部模拟包，即使
unittest.mock存在.