Sphinx 1.7

版本1.7.9（发布于2018年9月5日）

新增特性

  • #5359：通过对锚点进行排序，使生成的texinfo文件可再现

Bug 修复

  • #5361：如果文档使用 “include ”指令，则在增量生成时崩溃

版本1.7.8（发布于2018年8月29日）

不兼容的变更

  • “env.included” 的类型已更改为 set 的 dict 类

Bug 修复

  • #5320：intersphinx：如果给出无效的网址，则崩溃

  • #5326：manpage：将无效的文档名称指定为 “man_pages” 时崩溃

  • #5322：autodoc：任何类型提示都会导致格式错误

  • #5327：用生成的文件重建时出现“文档未包含在任何 toctree 中”的警告

  • #5335：quickstart：转义序列已在 MacPorts 的 Python 中显示

版本1.7.7（发布于2018年8月19日）

Bug 修复

  • #5198：仅包括用于并行构建的文件时，文档不在 toctree 中警告

  • LaTeX：减少 Latex 控制台输出中的“ PDF字符串中不允许令牌” hyperref警告（参考：＃5236）

  • LaTeX：在最新的 LaTeX 的控制台输出中取消显示 “ remreset 警告：remreset 包已过时”（参考：＃5237）

  • #5234：PDF输出：由于以下原因，自 Sphinx 1.5 以来，PAPER 环境变量的用法已损坏

  • LaTeX：：使用 XeLaTeX / LuaLateX 修复有关 Latin Modern 字体的 latex_engine 文档（参考：＃5251）

  • #5280：autodoc：修复错误的类型注释，以进行复杂的键入

  • autodoc：可选类型被错误地渲染

  • #5291：ForwardRef 类导致 autodoc 崩溃

  • #5211：autodoc：没有为 functools.partial 函数生成文档

  • #5306: autodoc：“getargspec()” 对无效的类型发出 NameError 警告

  • #5298：imgmath: math_number_all 使得程式中在 html 中出现了两个数字

  • #5294：在 PowerShell 中 sphinx-quickstart 出现空白提示

版本1.7.6（2018年7月17日发布）

Bug 修复

  • #5037：俄语中LaTeX \sphinxupquote{}

  • sphinx.testing 使用了不被推荐的 API; Node.get_marker(name)

  • ＃5016：启用 recommonmark 时崩溃

  • #5022: latex: crashed with Docutils package provided by Debian/Ubuntu

  • #5009：latex：如果表格没有标题，则表格标签消失

  • #5048：与编号 toctree 坠毁

  • #2410：C，呈现宏的空参数列表。

  • C ++，修复没有模板参数的完整模板专业化查找。

  • #4667：C ++，修复使用intersphinx时在全局范围内缺少引用的断言。 感谢Alan M. Carroll。

  • #5019：autodoc：因换页符而崩溃

  • #5032：autodoc：换页符导致崩溃

  • ＃5036：快速入门：按 Ctrl-U 键可清除整行

  • ＃5066：html：默认情况下不显示“关系”边栏

  • ＃5091：Latex：索引条目中的花括号未正确处理

  • #5070：epub：错误的内部 href 片段链接

  • ＃5104：apidoc：sphinx.apidoc：main() 的接口已更改

  • ＃4272：法语项目的PDF版本在XeTeX中存在问题

  • #5076: Python 3.7 中 napoleon 引发 RuntimeError 错误

  • #5125: sphinx-build：“sphinx:main()” 的接口已更改

  • sphinx-build：“sphinx.cmd.build.main()” 引用“sys.argv” 而不是给定参数

  • #5146：autosummary：当文档字符串的第一行以文字符号结尾时发出警告

  • autosummary：自动摘要警告表示位置错误（参考：＃5146）

  • #5143: autodoc：在检查不支持排序的对象之类的字典时崩溃

  • ＃5139：autodoc：如果枚举参数与另一个共享值，则缺少该参数

  • #4946: py domain: rtype field could not handle "None" as a type

  • ＃5176：LaTeX：包含 @ ， ! 或 " 的术语索引失败

  • ＃5161：html：如果复制静态文件失败，则崩溃

  • ＃5167：autodoc：修复带有两个以上参数的元组的格式类型注释

  • ＃3329：i18n：因自动符号脚注引用而崩溃

  • ＃5158：autosummary：以标题开头的模块摘要已被破坏

版本1.7.5（2018年5月29日发布）

Bug 修复

  • #4924: html search：任何其他语言的大写字符问题

  • ＃4932：apidoc：如果同级子程序包包含以下划线开头的模块，则将忽略某些子程序包

  • #4863, #4938, #4939：i18n 不能正确处理用于内容，主题，警告，表格和部分的node.title。

  • ＃4913：i18n：项目符号列表中的文字块未翻译

  • ＃4962：C ++，在重复声明中引发 TypeError。

  • ＃4825：C ++，当存在（转义）换行符时，可以正确解析 expr 角色并给出更好的错误消息。

  • C ++，请正确使用“ desc_addname”节点作为名称的前缀。

  • C ++，解析函数调用中的包扩展。

  • #4915, #4916：使用 dirhtml 生成器时搜索页面上的链接已损坏

  • #4969: autodoc：构造函数方法不应具有 return 批注

  • Latex：以非1开头的深度嵌套枚举列表会导致 LaTeX 引擎崩溃

  • #4978: Latex：没有为巴西语言环境设置shorthandoff

  • #4928: i18n：忽略LC_MESSAGES / 中的 .git / 等 dot-directories

  • #4946: py domain: type field could not handle "None" as a type

  • #4979:Latex：索引项中大括号的转义不正确

  • #4956:autodoc:未能从模拟模块上类的子类中提取文档

  • #4973:Latex：glossary指令为每个项添加空白

  • #4980：Latex：代码块上的显式标签是重复的

  • #4919页：node.asdom() 如果目录树有 :numbered: 则崩溃

  • #4914: autodoc：使用没有默认值的数据类时出现分析错误

  • #4931：autodoc：autodoc 跳过成员的处理程序引发错误时崩溃

  • #4931:autodoc:当模拟类的子类被napoleon模块处理时崩溃

  • #5007: sphinx-build 崩溃，当错误日志包含 "%" 字符

版本1.7.4（发布于2018年4月25日）

Bug 修复

  • #4885, #4887: domains: 与重复对象碰撞

  • #4889: Latex: sphinx.writers.latex 导致递归导入

版本1.7.3（发布于2018年4月23日）

Bug 修复

  • #4769: autodoc丢失第一个staticmethod参数

  • #4790:autosummary:PDF生成中的两列表太宽

  • #4795：Latex 个性化 详见：“_templates/longtable.tex_t” 现已损坏

  • #4789:图像转换器：被混淆转换Windows的.exe

  • #4783:在windows上，当srcdir和outdir的驱动器不同时，Sphinx崩溃

  • #4812:autodoc忽略带类型注释的变量

  • #4817：错误信息的错误 URL 警告

  • #4784:latex: latex_show_urls 如果替换中存在超链接，则分配错误的脚注编号

  • #4837:latex with class memoir错误：不支持字体命令“sf”

  • #4803:latex:与自动编号脚注的数量成比例太慢

  • #4838:htmlhelp:.hhp文件中的条目未排序

  • toctree 指令尝试全局查找具有查询字符串的URL

  • #4871:html搜索：德语中的大写字符问题

  • #4717:Latex:使用LuaLaTeX和Xeletex编译德语文档失败

  • #4459：复制标签检测器在并行构建中不能很好地工作

  • #4878：使用返回无效元数据的扩展崩溃

版本1.7.2（发布于2018年3月21日）

不兼容的变更

  • #4520:apidoc:TOC中不再排除具有空的uuu init_uu.py的文件夹

Bug 修复

  • #4669：sphinx.build_main 和 sphinx.make_main 移除了 NameError

  • #4685: autosummary 忽略意义警告

  • autodoc:在给定无效选项时崩溃

  • pydomain：如果为空，则始终去掉括号（参考：#1042）

  • #4689:autosummary:意外地删除包含“i.e.”的docstring

  • #4701:viewcode:在viewcode html输出中放错了“<div>”

  • #4701:viewcode:viewcode HTML输出中的“1”放错了位置

  • #4727:包textcomp的选项冲突

  • #4725:Sphinx 不能与 Python3.5.0 和 3.5.1 一起使用

  • #4716:在 Windows 上用 TexLive 生成 PDF 文件，找不到文件错误

  • #4574：Latex 中方程式前的垂直间距

  • #4720:生成器的图像不匹配时的消息不清楚

  • #4655, #4684: Incomplete localization strings in Polish and Chinese

  • #2286：Sphinx在呈现HTML页面时出错时崩溃

  • #4688：下载具有长URL的远程图像时出错

  • #4754: sphinx/pycode/__init__.py 引发 AttributeError

  • #1435: qthelp 生成器应使用 htmlescape 关键字

  • epub：复docTitle元素目录.ncx没有丢掉

  • #4520：apidoc：子包不在目录中（在1.6.6中引入）现已修复

  • #4767: html：搜索高亮显示打破了mathjax 程式

版本1.7.1（2018年2月23日发布）

已弃用

  • #4623：不推荐 sphinx.build_main()

  • autosummary：sphinx.ext.autosummary.get_documenter() 的接口已更改（从1.7.0开始）

  • #4664: 不推荐使用 sphinx.ext.intersphinx.debug()

有关更多详细信息，请参见 deprecation APIs list。

Bug 修复

  • #4608: epub: 生成无效标签

  • #4260: autodoc: 仅关键字参数分隔符如果出现在参数列表的顶部，则不会消失

  • #4622: epub: epub_scheme 对 content.opf 未奏效

  • ＃4627：graphviz：使graphviz图像适合页面

  • #4617: quickstart：要求有 PROJECT_DIR 参数

  • #4623: sphinx.build_main 在 1.7.0 中不复存在

  • ＃4615：sphinx.build 的参数已在1.7.0中更改

  • autosummary：sphinx.ext.autosummary.get_documenter() 的接口已更改

  • ＃4630：确定 sphinx.pot 中的 msgids 顺序

  • #4563: autosummary: 行尾标点检测不正确

  • #4577：枚举的子列表以明显的错误开头

  • #4641：TOC中的外部链接不能包含“？” 用 :glob: 选项

  • C ++，在表达式解析中添加缺少的显式转换和 typeid 解析。

  • C ++，在表达式解析中添加缺少的“ this”解析。

  • ＃4655：修复波兰语中不完整的本地化字符串

  • ＃4653：修复无参数 ImportErrors 的错误报告

  • ＃4664：再次读取 objects.inv 失败

  • ＃4662：遇到歧义时，带有“ term”目标的任何“ refs”崩溃

1.7.0版（2018年2月12日发行）

依赖

1.7.0b1

  • 新增 packaging 包

不兼容的变更

1.7.0b1

  • ＃3668：每个命令的主要功能的参数已更改

  • ＃3893：未知的 html_theme_options 引发警告而不是错误

  • ＃3927：Python 参数/变量类型应匹配类，而不是所有对象

  • ＃3962：当给定了--implicit-namespaces 选项而不是给定目录的子目录时，sphinx-apidoc现在将给定目录识别为隐式命名空间包。

  • #3929: apidoc: 将sphinx.apidoc 移动到 sphinx.ext.apidoc

  • ＃4226：apidoc：生成新样式的 makefile（make-mode）

  • ＃4274：sphinx-build 在参数错误时返回 2 作为退出代码

  • ＃4389：加载扩展名后将创建输出目录

  • autodoc does not generate warnings messages to the generated document even if keep_warnings is True. They are only emitted to stderr.

  • 从生成的conf.py中删除了shebang行

  • ＃2557：autodoc： autodoc_mock_imports 仅模拟指定的模块及其后代。 它不会模拟他们的父类。如果要模拟它们，请显式指定父类的名称。

  • ＃3620：html主题：将DOCUMENTATION_OPTIONS移至独立的JavaScript文件（参考号：＃4295）

  • ＃4246：限制所有主题的文本主体的宽度。可通过主题选项 body_min_width 和 body_max_width 进行配置。

  • ＃4771：apidoc：如果将 exclude_patterns 参数放在命令行选项之后，则会将其忽略

1.7.0b2

  • #4467：html theme：将 “csss” 重命名为 “css”

已弃用

1.7.0b1

  • using a string value for html_sidebars is deprecated and only list values will be accepted at 2.0.

  • 当前不推荐使用 “format_annotation()” 和 “formatargspec()”。请使用 “sphinx.util.inspect.Signature”。

  • sphinx.ext.autodoc.AutodocReporter is replaced by sphinx.util.docutils. switch_source_input() and now deprecated. It will be removed in Sphinx 2.0.

  • 当前不推荐使用 “sphinx.ext.autodoc.add_documenter()” 和 “AutoDirective._register”。请使用 “app.add_autodocumenter()”。

  • 当前不推荐使用 “AutoDirective._special_attrgetters”。请使用 “app.add_autodoc_attrgetter()”。

新增特性

1.7.0b1

  • C++，处理了 decltype(auto)。

  • ＃2406：C ++，添加适当的表达式解析，包括标识符的链接。

  • C ++，添加“ cpp：expr”角色以插入内联C ++表达式或类型。

  • C ++，支持带有速记模板前缀的显式成员实例化

  • C ++，使函数参数可链接，例如模板参数。

  • ＃3638：允许使用 math_eqref_format 更改对方程式的引用标签

  • 现在，suppress_warnings 接受以下配置：

    • ref.python （参见：#3866）

  • ＃3872：新增 Latex 键可配置 PDF 输出中的文字块标题位置（参考：＃3792，＃1723）

  • 如果缺少文档字符串，请尝试从基类中检索文档（参考：＃3140）

  • #4023: 当任一角色有多个目标时，请澄清错误消息。

  • #3973: epub：允许覆盖构建日期

  • #3972: epub: 按文件名对清单条目进行排序

  • #4052: viewcode：在突出显示模块代码之前进行排序

  • #1448: qthelp: 添加新的配置值； qthelp_namespace

  • ＃4140：html主题：使body标签可继承

  • ＃4168：使用 jieba 改进 zh 搜索

  • HTML 主题可以通过 theme.conf 设置默认侧边栏

  • ＃3160：html：使用 <kdb> 代表 :kbd: 角色

  • ＃4212：autosummary：导入模块时捕获所有异常

  • ＃4166：新增 math_numfig 以按部分对等式编号（参考号：＃3991，＃4080）。 感谢Oliver Jahn。

  • #4311：使 Latex 数字、表格和代码块遵从 numfig_secnum_depth 。

  • ＃947：autodoc现在支持ignore-module-all来忽略模块的__all__

  • ＃4332：让 LaTeX 遵守 math_numfig 进行方程式编号

  • #4093：sphinx-build 为未知目标/生成器创建空目录

  • 为 sphinx.ext.inheritance_diagram 扩展新增 top-classes 选项，以限制继承图的范围。

  • ＃4183：doctest：:pyversion: 选项也遵循PEP-440规范

  • ＃4235：html：新增 manpages_url 使手册页角色指向超链接

  • ＃3570：autodoc：不显示“ typing”。 类型提示模块

  • ＃4354：sphinx-build现在发出完成消息。 建设者可以通过“Builder.epilog”属性修改它

  • ＃4245：html主题：将“ language”新增到javascript vars列表

  • ＃4079：html：向每个代码块，文字和数学添加“ notranslate”类，以让Google Translate知道它们不可翻译

  • ＃4137：doctest：doctest块始终突出显示为python控制台（pycon）

  • ＃4137：doctest：testcode块始终突出显示为python

  • ＃3998：文本：默认情况下分配部分编号。 您可以使用 text_add_secnumbers 和 text_secnumber_suffix 来控制它。

1.7.0b2

  • ＃4271：sphinx-build支持名为-j auto的选项，以自动调整进程数。

  • Napoleon：添加了用于指定自定义栏标签的选项。

移除特性

1.7.0b1

  • 配置变量

    • html_use_smartypants

    • latex_keep_old_macro_names

    • latex_elements['footer']

  • utility methods of sphinx.application.Sphinx class

    • buildername (property)

    • _display_chunk()

    • old_status_iterator()

    • status_iterator()

    • _directive_helper()

  • sphinx.environment.BuildEnvironment 类的实用方法

    • currmodule（属性）

    • currclass（属性）

  • epub2 生成器

  • warn() 的前缀和 colorfunc 参数

  • sphinx.util.compat 模块

  • sphinx.util.nodes.process_only_nodes()

  • LaTeX环境 notice，请改用 sphinxadmonition

  • LaTeX \sphinxstylethead, 使用·\sphinxstyletheadfamily

  • C ++，支持功能概念。 感谢 mickk-on-cpp。

  • 未使用且以前未记录的 LaTeX 宏 \ shortversion 和 \ setshortversion

Bug 修复

1.7.0b1

  • ＃3882：更新HTMLHelp和QTHelp的文件顺序

  • ＃3962：sphinx-apidoc 无法正确识别隐式名称空间包

  • ＃4094：C ++，允许使用空模板参数列表。

  • C ++，在具有限定名称的声明名称中也具有超链接类型。

  • C ++，不要在概念内部为声明添加索引条目。

  • C ++支持依赖名称的模板歧义消除器。

  • ＃4314：对于PDF“ howto”文档，代码块的编号与图形和表格之一不同

  • ＃4330：PDF“ howto”文档的默认LaTeX tocdepth计数器设置不一致

  • #4198：autosummary发出多个“autodoc process docstring”事件。感谢乔尔·诺特曼。

  • #4081：构建时警告和错误颜色相同

  • Latex：如果未设置 release，则不显示 'Release' 标签

1.7.0b2

  • ＃4415：autodoc 将继承的类方法分类为常规方法

  • ＃4415：autodoc将继承的静态方法分类为常规方法

  • #4472：DOCUMENTATION_OPTIONS 未被定义

  • ＃4491：autodoc：比sys.meta_path中的其他进口商更喜欢_MockImporter

  • ＃4490：autodoc：类型注释已被 Python 3.7.0a4 + 破坏

  • 不再安装 utils 包

  • #3952: apidoc: 模块标头太转义

  • ＃4275：sphinx.util.i18n.format_date接受的格式受到限制

  • ＃4493：如果启用了AutoStructify，则 recommonmark 会引发 AttributeError

  • ＃4209：intersphinx：在链接标题中，如果目标没有版本，则“ v”应该是可选的

  • #4230: slowdown in writing pages with Sphinx 1.6

  • ＃4522：epub：即使配置更改也不会重建文档

1.7.0b3

  • ＃4019：Inheritance_diagram AttributeError 停止 make 进程

  • #4531: autosummary：方法不视为属性

  • #4538: autodoc：“sphinx.ext.autodoc.Options” 已移除

  • #4539: autodoc 对部分方法发出警告

  • #4223: doctest：测试失败，报告错误文件，错误行

  • i18n：如果为 sphinx-build 给出了特定的文件名作为参数，则不会编译消息目录（参考：＃4560）

  • ＃4027：sphinx.ext.autosectionlabel现在期望标签与原始源中的标签相同； 无只能引用，无装饰。

  • #4581: apidoc: 仍包含排除的模块

测试

1.7.0b1

  • Add support for Docutils 0.14

  • “sphinx.ext.inheritance_diagram” 插件新增测试