Sphinx 1.7¶
版本1.7.9（2018年9月5日发布）¶
功能添加¶
#5359：通过对锚点进行排序，使生成的texinfo文件可重复
错误已修复¶
#5361：如果文档使用包含指令，增量构建时崩溃
版本1.7.8（2018年8月29日发布）¶
不兼容的更改¶
的类型
env.included已更改为集法令
错误已修复¶
#5320：interphinx：如果给出无效URL，则崩溃
#5326：manpage：当文档名被指定为无效时崩溃
man_pages#5322：autodoc：
Anytypehint导致格式错误#5327：使用生成的文件重建时发出“文档未包含在任何toctree中”警告
#5335：quickstart：已使用MacPorts的Python显示了越狱序列
版本1.7.7（2018年8月19日发布）¶
错误已修复¶
#5198：当仅包括并行构建的文件时，文档不在toctree警告中
LaTeX：减少乳胶控制台输出中的“PDF字符串中不允许使用Token”超引用警告（参考：#5236）
LaTeX：在带有最近LaTeX的乳胶控制台输出中抑制“remreset警告：remreset包已过时”（参考文献：#5237）
#5234：PDF输出：自Sphinx 1.5以来，PAPER环境变量的使用已中断
LaTeX：修复
latex_engine关于XeLaTeX/LuaLateX的Latin Modern字体的文档（参考文献：#5251）#5280：autodoc：修复复杂类型的错误类型注释
autodoc：可选类型被错误呈现
#5291：autodoc因ForwardRef类型崩溃
#5211：autodoc：未为functools.部分函数生成文档
#5306：autodoc：
getargspec()引发无效类型提示的Name错误#5298：imgmath：math_number_all导致方程在html中包含两个数字
#5294：Shell中的phinx-quickstart空白提示
版本1.7.6（2018年7月17日发布）¶
错误已修复¶
#5037：LaTeX
\sphinxupquote{}俄语中断phinx.testing使用废弃的pytest API;
Node.get_marker(name)#5016：重新标记时崩溃。启用自动验证
#5022：乳胶：与Debian/Ubuntu提供的Docutils包崩溃
#5009：乳胶：如果桌子没有标题，桌子的标签将消失
#5048：与编号的toctree一起崩溃
#2410：C，为宏呈现空参数列表。
C++，修复了没有模板参数的完整模板专业化查找。
#4667：C++，修复了使用interphinx时全局作用域中缺失引用的断言。感谢艾伦·M。卡罗尔。
#5019：autodoc：因表单提要字符崩溃
#5032：autodoc：丢失旧样式类的第一个staticmethod参数
#5036：快速启动：输入Ctrl-U可清除整行
#5066：html：默认情况下不显示“relations”侧边栏
#5091：latex：索引条目中的花括号处理不当
#5070：epub：错误的内部href片段链接
#5104：apidoc：接口
sphinx.apidoc:main()已经改变#4272：法国项目的PDF构建与XeTeX存在问题
#5076：napbitt使用Python 3.7引发Runtime错误
#5125：sphinx-build：Interface of
sphinx:main()已经改变Sphinx建造：
sphinx.cmd.build.main()指sys.argv而不是给出的论点#5146：autosummary：当文档字符串的第一行以文字符号结束时，会发出警告
自动摘要：自动摘要的警告指示错误的位置（参考：#5146）
#5143：autodoc：在检查dict类似不支持排序的对象时崩溃
#5139：autodoc：如果Enum参数与另一个参数共享价值，则缺少Enum参数
#4946：py域：rype字段无法将“'无'”作为类型处理
#5176：LaTeX：包含以下术语的索引
@,!，或者"失败#5161：html：如果复制静态文件失败，就会崩溃
#5167：autodoc：修复具有两个以上参数的二元组的格式类型注释
#3329：i18 n：因自动符号脚注引用而崩溃
#5158：自动摘要：模块摘要以标题开头时已被破坏
版本1.7.5（2018年5月29日发布）¶
错误已修复¶
#4924：html搜索：任何其他语言中的大写字符问题
#4932：apidoc：如果兄弟子包包含以强调线开始的模块，则会忽略某些子包
#4863、#4938、#4939：i18 n无法正确处理用于内容、主题、警告、表格和部分的节点.title。
#4913：i18 n：项目符号列表中的文字块未翻译
#4962：C++，重复声明时引发了TypHelp。
#4825：C++，正确解析expr角色，并在存在（逸出）断点时给出更好的错误消息。
C++，正确使用
desc_addname名称前置的节点。C++，解析函数调用中的包扩展。
#4915、#4916：使用dirhtml构建器时搜索页面上的链接被破坏
#4969：autodoc：构造函数方法不应具有返回注释
latex：以非1开头的深嵌套列举列表导致LaTeX引擎崩溃
#4978：乳胶：短链不适用于巴西地区
#4928：i18 n：忽略LC_MESSAGES/中的.git/等点目录
#4946：py domain：type field could not handle“
None”as a type#4979：latex：索引条目中的花括号转义错误
#4956：autodoc：无法从被模仿模块上的类的子集中提取文档
#4973：latex：术语表指令为每个项目添加空白
#4980：latex：代码块上的显式标签重复
#4919：如果toctree具有：anned：选项，那么节点.asdom（）就会崩溃
#4914：autodoc：使用没有默认值的类时出现解析错误
#4931：autodoc：当autodoc-skip-member的处理程序引发错误时崩溃
#4931：autodoc：当napterm模块处理被模仿类的子集时崩溃
#5007：当错误日志包含“%”字符时，phinx构建崩溃
版本1.7.4（2018年4月25日发布）¶
错误已修复¶
#4885、#4887：域：已崩溃，对象重复
#4889：latex：phinx.writers.latex导致循环导入
版本1.7.3（2018年4月23日发布）¶
错误已修复¶
#4769：autodoc丢失第一个静态方法参数
#4790：自动摘要：PDF构建中的两列表太宽
#4795：通过乳胶定制
_templates/longtable.tex_t坏了#4789：imgconverter：被Windows的convert.EE混淆
#4783：在Windows上，当srCDir和outchar的驱动器不同时，Sphinx崩溃
#4812：autodoc忽略类型注释变量
#4817：警告消息上的URL错误
#4784：乳胶：
latex_show_urls如果替换中存在超链接，则分配错误的脚注号#4837：带有类回忆录的乳胶错误：字体命令
\sf不支持#4803：latex：与自动编号脚注的数量成比例太慢
#4838：htmlHelp：. hhp文件中的条目未排序
toctree指令尝试搜索具有select_strings的URL
#4871：html搜索：德语中的大写字符问题
#4717：latex：LuaLaTeX和XeLaTeX的德语文档编译失败
#4459：重复标签检测器在并行构建中工作不佳
#4878：扩展包崩溃，扩展包返回无效元数据
版本1.7.2（2018年3月21日发布）¶
不兼容的更改¶
#4520：apidoc：有空的文件夹 __init__. py不再被排除在SOC之外
错误已修复¶
#4669：sphinx.build_main和sphinx.make_main抛出NameError
#4685：自动摘要发出毫无意义的警告
autodoc：当提供无效选项时崩溃
pydomain：如果为空，则始终删除括号（参考文献：#1042）
#4689：自动摘要：意外剥离包含“i.e. "
#4701：查看代码：放错地方
<div>在视图代码html输出中#4444：不要求numfig在部分上用途：numref：
#4727：包textopp的选项冲突
#4725：Sphinx不支持Python 3.5.0和3.5.1
#4716：在Windows上使用TexLive生成PDF文件，文件找不到错误
#4574：乳胶中方程式前的垂直空间
#4720：图像与构建器不匹配时的消息不清楚
#4655、#4684：波兰语和中文本地化字符串不完整
#2286：Sphinx在渲染HTML页面时发生错误时崩溃
#4688：下载具有长URL的远程图像时出错
#4754： sphinx/pycode/__init__. py引发AttribeRight
#1435：qthelp构建器应该htmlescape关键字
epub：修复toc.ncx的docTitle元素未逸出
#4520：apidoc：子包不在toc中（在1.6.6中引入）现已修复
#4767：html：搜索突出显示打破数学方程
版本1.7.1（2018年2月23日发布）¶
弃用¶
#4623：
sphinx.build_main()已经过时了autosummary：接口
sphinx.ext.autosummary.get_documenter()已更改（自1.7.0起）四六六四号：
sphinx.ext.intersphinx.debug()已经过时了
详情见 deprecation APIs list .
错误已修复¶
#4608：epub：生成了无效的Meta标记
#4260：autodoc：如果仅关键字参数分隔符出现在参数列表顶部，则不会消失
#4622：epub：
epub_scheme不影响内容.opf#4627：graphviz：将graphviz图像匹配到页面
#4617：快速启动：需要PROTENT_SYS参数
#4623：sphinx.build_main在1.7.0中不再存在
#4615：的论点
sphinx.build已在1.7.0中更改autosummary：接口
sphinx.ext.autosummary.get_documenter()已更改#4630：在phinx中对msgids进行订单。pot datecolithic
#4563：自动摘要：行尾标点检测不正确
#4577：列举的子列表显式开头错误
#4641：目录中的外部链接不能包含“？“与
:glob:选项C++，在表达解析中添加显式转换和typeid的缺失解析。
C++，添加缺失的解析
this在表达解析中。#4655：修复波兰语中不完整的本地化字符串
#4653：修复无参数ImportErrors的错误报告
#4664：读取对象.inv再次失败
#4662：
any参考term当遇到模糊性时，目标崩溃
版本1.7.0（2018年2月12日发布）¶
依赖关系¶
1.7.0b1
添加
packaging包
不兼容的更改¶
1.7.0b1
#3668：每个命令的主要功能的参数已更改
#3893：未知的html_theme_select会引发警告而不是错误
#3927：Python参数/变量类型应该匹配类，而不是所有对象
#3962：当出现时，phinx-apidoc现在将给定目录识别为隐式命名空间包
--implicit-namespaces给定的选项，而不是给定目录的子目录。#3929：apidoc：将phinx.apidoc移至phinx.ext.apidoc
#4226：apidoc：生成新样式makefile（make-mode）
#4274：phinx-Build在参数错误时返回2作为退出代码
#4389：加载扩展后将创建输出目录
autodoc不会向生成的文档生成警告消息，即使
keep_warnings是True. 它们仅发射到stderr。shebang行已从生成的conf.py中删除
#2557：autodoc：
autodoc_mock_imports仅嘲笑指定模块及其后代。 它并没有嘲笑他们的祖先。 如果你想嘲笑他们，请明确指定祖先的名字。#3620：html主题：将DOCUMENTATION_OPTIONS移动到独立的JavaScript文件（参考：#4295）
#4246：限制所有主题的文本正文宽度。可通过主题选项配置
body_min_width和body_max_width.#4771：apidoc：The
exclude_patterns如果参数放置在命令行选项之后，则会被忽略
1.7.0b2
#4467：html主题：收件箱
csss块以css
弃用¶
1.7.0b1
使用字符串值
html_sidebars已被弃用，并且2.0时仅接受列表值。format_annotation()和formatargspec()已经过时了 请使用sphinx.util.inspect.Signature而不是.sphinx.ext.autodoc.AutodocReporter被替换为sphinx.util.docutils. switch_source_input()现在被废弃了。 它将在Sphinx 2.0中被删除。sphinx.ext.autodoc.add_documenter()和AutoDirective._register现在已被废弃。 请使用app.add_autodocumenter()而不是.AutoDirective._special_attrgetters现在已被废弃。 请使用app.add_autodoc_attrgetter()而不是.
功能添加¶
1.7.0b1
C++，handle
decltype(auto).#2406：C++，添加正确的表达解析，包括标识符的链接。
C++，添加
cpp:expr用于插入内联C++运算式或类型的角色。C++，通过简写支持显式成员实例化
template前缀C++，将函数参数设置为预设，就像模板参数一样。
#3638：允许使用更改方程引用的标签
math_eqref_format现在
suppress_warnings接受以下配置：ref.python(ref：#3866）
#3872：添加乳胶密钥以配置PDF输出中的文字块标题位置（参考#3792、#1723）
如果缺少文档字符串，请尝试从基本类中检索文档（参考号：#3140）
#4023：当任何角色具有多个目标时，澄清错误消息。
#3973：epub：允许覆盖构建日期
#3972：epub：按文件名对清单条目排序
#4052：viewcode：在突出显示模块代码之前排序
#1448：qthelp：添加新配置值;
qthelp_namespace#4140：html主题：使正文标签可继承
#4168：用jieba改进zh搜索
HTML主题可以通过
theme.conf#3160：html：使用
<kdb>代表:kbd:作用#4212：自动摘要：导入模块时捕获所有异常
#4166：添加
math_numfig用于按部分进行方程编号（参考文献：#3991、#4080）。感谢奥利弗·扬恩。#4311：让LaTeX服从
numfig_secnum_depth对于图形、表格和代码块#947：autodoc现在支持使用automre-module-all来忽略模块的
__all__#4332：让LaTeX服从
math_numfig用于公式编号#4093：phinx-Build为未知目标/构建器创建空目录
添加
top-classes选项sphinx.ext.inheritance_diagram扩展以限制继承图的范围。#4183：doctest：
:pyversion:选项还遵循PEP-440规范#4235：html：添加
manpages_url将手册页角色创建到超链接#3570：autodoc：不显示“打字”。'类型提示模块
#4354：phinx-Build现在发出完成消息。 建设者可以通过修改它
Builder.epilog属性#4245：html主题：添加
language到JavaScript vars列表#4079：html：添加
notranslate对每个代码块、文字和数学进行类，让Google Translate知道它们不可翻译#4137：docTest：docTest块始终突出显示为Python控制台（pycon）
#4137：docTest：testCode块始终突出显示为Python
#3998：text：默认情况下分配节数。 您可以使用
text_add_secnumbers和text_secnumber_suffix
1.7.0b2
#4271：phinx-Build支持名为
-j auto自动调整进程数量。Napoleon：添加了指定自定义部分标签的选项。
功能已删除¶
1.7.0b1
配置变量
html_use_smartypantslatex_keep_old_macro_nameslatex_elements ['footer']
实用方法
sphinx.application.Sphinx类构建器名称（财产）
_show_chunk（）
old_Status_iterator（）
Status_iterator（）
_指令_helper（）
实用方法
sphinx.environment.BuildEnvironment类currmodule（属性）
currClass（财产）
epub 2构建者
warn（）的prefix和colorfunc参数
sphinx.util.compat模块sphinx.util.nodes.process_only_nodes()LaTeX环境
notice，使用sphinxadmonition相反胶乳
\sphinxstylethead，使用\sphinxstyletheadfamilyC++，支持功能概念。感谢mickk-on-cpp。
未使用且之前未记录LaTeX宏
\shortversion和\setshortversion
错误已修复¶
1.7.0b1
#3882：更新HTMLHelp和QTHelp的文件顺序
#3962：phinx-apidoc无法正确识别隐式命名空间包
#4094：C++，允许空模板参数列表。
C++，也可以在具有限定名称的声明名称中超链接类型。
C++，不为概念内部的声明添加索引条目。
C++，支持依赖名称的模板歧义器。
#4314：对于PDF“howto”文档，代码块的编号与图形和表格的编号不同
#4330：PDF“howto”文档的默认LaTeX tocdepth计数器设置不连贯
#4198：autosummary发出多个“autodoc-Process-docstringer”事件。感谢乔尔·诺斯曼。
#4081：构建时收件箱和错误颜色相同
乳胶：如果出现以下情况，请勿显示“释放”标签
release未设置
1.7.0b2
#4415：autodoc将继承的类方法分类为常规方法
#4415：autodoc将继承的静态方法分类为常规方法
#4472：DOCUMENTION_OPTIONS未定义
#4491：autodoc：prefer _MockImporter而不是sys.Meta_路径中的其他导入器
#4490：autodoc：python3.7.0a4+破坏了类型注释
不再安装utils包
#3952：apidoc：模块头太逸出
#4275：phinx.util.i18n.format_Date接受的格式有限
#4493：如果启用AutoStructtify，recommonmark会引发AttribeRight
#4209：interphinx：如果目标没有版本，在链接标题中，“v”应该是可选的
#4230：使用Sphinx 1.6写页面的速度变慢
#4522：epub：即使配置更改，文档也不会重建
1.7.0b3
#4019：继承_图表属性停止制作过程时出错
#4531：自动摘要：方法不被视为属性
#4538：autodoc：
sphinx.ext.autodoc.Options已移动#4539：autodoc为partial方法发出警告
#4223：docTest：在错误的文件、错误的行中报告失败的测试
i18 n：如果给出特定文件名，则不会编译消息目录
sphinx-build作为参数（参考文献：#4560）#4027：phinx.ext.autosectionLabel现在希望标签与原始源中的标签相同;没有聪明的引言，没有花哨的东西。
#4581：apidoc：排除的模块仍包括在内
测试¶
1.7.0b1
添加对Docutils 0.14的支持
添加测试
sphinx.ext.inheritance_diagram扩展名.