Sphinx 1.8

版本1.8.6（2021年11月18日发布）

依赖关系

  • #9807：将Docutils限制为0.17.x或更高

版本1.8.5（2019年3月10日发布）

错误已修复

  • LaTeX：删除PDF标题页面上作者姓名后面的多余空白（参考文献：#6004）

  • #6026：LaTeX：对定义列表的交叉引用无效

  • #6046：LaTeX： TypeError 当给出无效的latex_elements时引发

  • #6067：LaTeX：具有目标的图像连接到下一行

  • #6067：LaTeX：即使指定，具有目标的图像也不会对齐

  • #6149：LaTeX： :index: 标题中的角色原因 Use of \@icentercr doesn't match its definition latexpdf build错误

  • #6019：IMG转换器：包含多页PDF失败

  • #6047：autodoc： autofunction 为方法对象发出警告

  • #6028：graphviz：确保graphviz文件名可重复

  • #6068：doctests： skipif 选项可能会从文档中删除代码块

  • #6136： :name: 选择 math 指令导致崩溃

  • #6139：intersphinx：ValueError on failure reporting

  • #6135：更改：找到任何模块时修复UnboundLocal错误

  • #3859：manpage：代码块标题未正确显示

版本1.8.4（2019年2月3日发布）

错误已修复

  • #3707：乳胶：没有可用的粗体勾选标记（RST）。

  • #5605：文档语言设置为中文时，无法搜索英语单词。

  • #5889：LaTeX：用户 numfig_format 空间被剥夺并可能导致建造失败

  • C++，修复涉及东cv限定符的声明的超链接。

  • #5755：C++，修复了返回类型中具有约束的函数模板上的重复声明错误。

  • C++，解析一元右折叠式和二进制折叠式。

  • pycode无法处理Windows上的egg文件

  • #5928：运行构建时Key错误：“DOCUTILSCONUTE”

  • #5936：LaTeX：因警告中包含高于页面高度的图像而破坏了PDF构建

  • #5231：“make html”不会读取和构建“locale”目录中的“po”文件

  • 五九五四号： :scale: 如果警告中包含图像，图像选项可能会破坏PDF构建

  • #5966：增量构建时尚未加载mathbox

  • #5960：LaTeX：自2018年9月以来修改了PDF布局TeXLive更新 parskip.sty

  • #5948：LaTeX：为部分生成重复的标签

  • #5958：versionadded指令导致Python 3.5.0崩溃

  • #5995：autodoc：autodoc_mock_imports与Python 3.7上的元类冲突

  • #5871：texinfo：部分标题 . 不允许

版本1.8.3（2018年12月26日发布）

功能添加

  • LaTeX: it is possible to insert custom material to appear on back of title page, see discussion of 'maketitle' key of latex_elements ('manual' docclass only)

错误已修复

  • #5725：mathspel：默认情况下使用“最新”版本的CDO URL

  • #5460：html搜索不适用于某些第三方主题

  • #5520：LaTeX，自Sphinx 1.6以来的标题包不兼容

  • #5614：autodoc：导入内置模块时增量构建被破坏

  • #5627：qthelp：QtHelp中缺少index.html

  • #5659：linkcheck：包含多字节字符的超链接崩溃

  • #5754：Doc：修复中的一些错误 Latex 定制

  • #5810：LaTeX：phinxVerbatim自1.6.6以来需要明确的“hllines”设置（参考文献：#1238）

  • #5636：C++，修复了浮点字面量的解析。

  • #5496（再次）：C++，修复部分构建中存在重复的断言。

  • #5724：quickstart：当$LC_ALL为空时，phinx-quickstart失败

  • #1956：默认conf.py不符合PEP 8

  • #5849：LaTeX：文档类 \maketitle 已被覆盖，无法使用原始含义来代替狮身克斯定制含义

  • #5834：apidoc：错误的帮助 --tocfile

  • #5800：todo：如果todo在文本元素中定义，则崩溃

  • #5846：htmlHelp：将.hhc/.hHK文件中的十六进制转码转换为小数转码

  • htmlHelp：标题包含双引号时生成breaked. hck文件

版本1.8.2（2018年11月11日发布）

不兼容的更改

  • #5497：除非确实需要，否则请勿包含MathJax.js和jsmath.js

功能添加

  • #5471：显示适当的弃用警告

错误已修复

  • #5490：latex：列举列表导致recommonmark崩溃

  • #5492：phinx-buy无法构建带有Python < 3.5.2的文档

  • #3704：乳胶：错误 \label 带有传奇人物的定位

  • #5496：C++，修复符号声明两次以上时的断言。

  • #5493：gettext：崩溃，模板损坏

  • #5495：包含的文件中具有文件选项的sv-table指令已损坏（参考文献：#4821）

  • #5498：autodoc：无法找到类型提示 functools.partial

  • #5480：autodoc：无法找到无法解析的Forward引用的类型提示

  • #5419：已生成不兼容的math_block节点

  • #5548：修复预先存在文件的情况下的ensuredis（）

  • #5549：graphviz正确处理不存在的静态目录

  • #3002：i18 n：引用同一脚注的多个脚注_引用导致重复的节点_id

  • #5563：latex：扩展生成的脚注_引用导致LaTeX构建器崩溃

  • #5561：make all-pdf fails with old xindy version

  • #5557：快速启动：--不尊重无批处理文件

  • #3080：texinfo：多行标题已被打破

  • #3080：texinfo：多行引用被打破

版本1.8.1（2018年9月22日发布）

不兼容的更改

  • 胶乳 \pagestyle 命令已移至LaTeX模板。PDF中没有更改，除非有以下情况 \sphinxtableofcontents 包含它们的，是在 conf.py . (refs：#5455）

错误已修复

  • #5418：phinx-Build-d/doctree文件的默认路径不正确

  • #5421：autodoc发出弃用警告 autodoc_default_flags

  • #5422：ambda对象导致存储环境上的Pickling错误

  • #5417：Sphinx无法在Python 2.7.5中构建语法错误

  • #4911：将latexpdf添加到make. mat，用于非make-模式

  • #5436：Autodoc不使用具有属性/方法的enum子类

  • #5437：autodoc：导入鸡蛋的模块崩溃

  • #5433：latex：Import错误：无法导入名称“DID_SETTINGS”

  • #5431：autodoc： autofunction 为可调用对象发出警告

  • #5457：在禁止覆盖时修复错误消息中的类型错误

  • #5453：“howto”文档的PDF构建没有页面编号

  • #5463：mathbase：math_role和MathDirective在1.8.0中消失

  • #5454：latex：索引已从PDF中消失

  • #5432：py域： :type: 字段无法处理 :term: 引用

  • #5426：py domain：TypeError has been raised for class attribute

版本1.8.0（2018年9月13日发布）

依赖关系

1.8.0b1

  • LaTeX： latex_use_xindy 如果 True （默认为 xelatex/lualatex ）、指示 make latexpdf 使用 xindy 一般指数。 确保您的LaTeX发行版包含它。（参考文献：#5134）

  • LaTeX： latexmk 需要 make latexpdf 在Windows上

不兼容的更改

1.8.0b2

  • #5282：html主题：参考 pygments_style 优先设置HTML主题

  • 下载文件的网址更改

  • #5127：快速入门： Makefile 和 make.bat 如果存在，则不会覆盖

1.8.0b1

  • #5156： sphinx.ext.graphviz 延伸运行 dot 在正在构建的文档的目录中，而不是在文档的根目录中。

  • #4460：将任何数据存储到环境的扩展应返回其dev数据结构的版本作为元数据。 详情请参阅 扩展元数据 .

  • Sphinx期望源解析器模块支持的文件格式为 Parser.supported 属性

  • 的默认值 epub_author 和 epub_publisher 从 'unknown' 的值 author . 这与一个相同 conf.py 文件sphinx-build生成。

  • 的 gettext_compact 属性已从 document.settings object. 请使用 config.gettext_compact 而不是.

  • 阅读阶段的处理顺序发生变化。 smart_quotes、狮身X域名、 doctree-read 事件和版本控制文档树的调用比目前更早。欲了解更多详情，请阅读 Sphinx.add_transform()

  • #4827：所有 substitution_definition 在读取阶段从doctree中删除节点

  • docutils.conf 在 $HOME 或 /etc 目录被忽略。 只 docutils.conf 来自Conf迪尔的命令是服从的。

  • #789： :samp: 角色支持用反斜线摆脱花括号

  • #4811：下的文件 html_static_path 从源文件中排除。

  • 乳胶：使用 \sphinxcite 改为引用参考 \hyperref

  • 配置值 viewcode_import 被重命名为 viewcode_follow_imported_members (refs：#4035）

  • #1857：乳胶： latex_show_pagerefs 不为引用添加pagerefs

  • #4648：latex：现在“rubric”元素呈现为未编号的部分标题

  • #4983：html：Productionlist令牌的锚点已更改

  • 修改模板变量 script_files 现在允许使用模板。请使用 app.add_js_file() 而不是.

  • #5072：仅使用新文档保存环境对象

  • #5035：qthelp构建器允许破折号 qthelp_namespace

  • LaTeX：默认使用lualatex或xelatex xindy 作为UTF-8能够取代 makeindex (refs：#5134）。 升级Sphinx后，请在新构建之前清洁现有项目的乳胶构建储备。

  • #5163：html：hlist项目现在对齐顶部

  • highlightlang 在解析阶段处理指令

  • #4000：LaTeX：模板已更改。 以下元素已移至其中：

    • \begin{document}

    • shorthandoff 可变

    • maketitle 可变

    • tableofcontents 可变

弃用

1.8.0b2

  • sphinx.io.SphinxI18nReader.set_lineno_for_reporter() 已弃用

  • sphinx.io.SphinxI18nReader.line 已弃用

  • sphinx.util.i18n.find_catalog_source_file() 已经改变; gettext_compact 论点已被否决

  • #5403： sphinx.util.images.guess_mimetype() 已经改变; content 论点已被否决

1.8.0b1

  • source_parsers 已弃用

  • autodoc_default_flags 已弃用

  • 快速入门： --epub 选项成为默认选项，因此已被弃用

  • 基于指令支持的删除功能。 目前，Sphinx仅支持基于类的指令（请参阅 Directive )

  • sphinx.util.docutils.directive_helper() 已弃用

  • sphinx.cmdline 已弃用

  • sphinx.make_mode 已弃用

  • sphinx.locale.l_() 已弃用

  • #2157：助手功能 warn() 对于HTML主题已被弃用

  • app.override_domain() 已弃用

  • app.add_stylesheet() 已弃用

  • app.add_javascript() 已弃用

  • app.import_object() 已弃用

  • app.add_source_parser() 已经改变; suffix 论点已被否决

  • sphinx.versioning.prepare() 已弃用

  • Config.__init__() 已经改变; dirname , filename 和 tags 论点已被否决

  • Config.check_types() 已弃用

  • Config.check_unicode() 已弃用

  • sphinx.application.CONFIG_FILENAME 已弃用

  • highlightlang 指令已被废弃

  • BuildEnvironment.load() 已弃用

  • BuildEnvironment.loads() 已弃用

  • BuildEnvironment.frompickle() 已弃用

  • env.read_doc() 已弃用

  • env.update() 已弃用

  • env._read_serial() 已弃用

  • env._read_parallel() 已弃用

  • env.write_doctree() 已弃用

  • env._nitpick_ignore 已弃用

  • env.versionchanges 已弃用

  • env.dump() 已弃用

  • env.dumps() 已弃用

  • env.topickle() 已弃用

  • env.note_versionchange() 已弃用

  • sphinx.writers.latex.Table.caption_footnotetexts 已弃用

  • sphinx.writers.latex.Table.header_footnotetexts 已弃用

  • sphinx.writers.latex.LaTeXTranslator.footnotestack 已弃用

  • sphinx.writers.latex.LaTeXTranslator.in_container_literal_block 已弃用

  • sphinx.writers.latex.LaTeXTranslator.next_section_ids 已弃用

  • sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids 已弃用

  • sphinx.writers.latex.LaTeXTranslator.restrict_footnote() 已弃用

  • sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote() 已弃用

  • sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids() 已弃用

  • sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids() 已弃用

  • sphinx.writers.latex.LaTeXTranslator.check_latex_elements() 已弃用

  • sphinx.writers.latex.LaTeXTranslator.bibitems 已弃用

  • sphinx.writers.latex.LaTeXTranslator.hlsettingstack 已弃用

  • sphinx.writers.latex.ExtBabel.get_shorthandoff() 已弃用

  • sphinx.writers.html.HTMLTranslator.highlightlang 已弃用

  • sphinx.writers.html.HTMLTranslator.highlightlang_base 已弃用

  • sphinx.writers.html.HTMLTranslator.highlightlangopts 已弃用

  • sphinx.writers.html.HTMLTranslator.highlightlinenothreshold 已弃用

  • sphinx.writers.html5.HTMLTranslator.highlightlang 已弃用

  • sphinx.writers.html5.HTMLTranslator.highlightlang_base 已弃用

  • sphinx.writers.html5.HTMLTranslator.highlightlangopts 已弃用

  • sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold 已弃用

  • sphinx.ext.mathbase 扩展已被废弃

  • sphinx.ext.mathbase.math 节点已被废弃

  • sphinx.ext.mathbase.displaymath 节点已被废弃

  • sphinx.ext.mathbase.eqref 节点已被废弃

  • sphinx.ext.mathbase.is_in_section_title() 已弃用

  • sphinx.ext.mathbase.MathDomain 已弃用

  • sphinx.ext.mathbase.MathDirective 已弃用

  • sphinx.ext.mathbase.math_role 已弃用

  • sphinx.ext.mathbase.setup_math() 已弃用

  • sphinx.directives.other.VersionChanges 已弃用

  • sphinx.highlighting.PygmentsBridge.unhighlight() 已弃用

  • sphinx.ext.mathbase.get_node_equation_number() 已弃用

  • sphinx.ext.mathbase.wrap_displaymath() 已弃用

  • 的 trim_doctest_flags 论点 sphinx.highlighting.PygmentsBridge 已弃用

详情见 deprecation APIs list .

功能添加

1.8.0b2

  • #5388：确保冻结对象描述可重现

  • #5362：apidoc：添加 --tocfile 更改ToC文件名的选项

1.8.0b1

  • 添加 config-inited 事件

  • 添加 sphinx.config.Any 为了表示配置值，接受任何类型的值

  • source_suffix 允许将文件ext映射到文件类型

  • 添加 author 作为配置值

  • #2852：imgconverter：支持将GIF转换为PNG

  • sphinx-build 命令支持i18 n控制台输出

  • 添加 app.add_message_catalog() 和 sphinx.locale.get_translations() 支持第三方扩展的翻译

  • helper函数 warning() 添加了HTML主题

  • 添加 Domain.enumerable_nodes 管理域自己的可调度节点（实验性）

  • 添加新关键字参数 override 到应用程序API

  • LaTeX：新钥匙 'fvset' 为 latex_elements .对于XeLaTeX/LuaLaTeX，其默认设置 fanvyvrb 在代码块中使用正常而不是小的字体大小（参考文献：#4793）

  • 添加 html_css_files 和 epub_css_files 用于从配置添加CSS文件

  • 添加 html_js_files 用于从配置添加JS文件

  • #4834：确保设置的对象描述可重复。

  • #4828：允许覆盖 numfig_format 部分。 不需要完整的定义。

  • 改进包含期间的警告消息（参考文献：#4818）

  • LaTeX：单独定制 guilabel 和 menuselection (refs：#4830）

  • 添加 Config.read() 从配置文件创建新配置对象的class方法

  • #4866：将graphviz图表包装在 <div> 标签

  • 查看代码：添加 viewcode-find-source 和 viewcode-follow-imported 在不加载的情况下加载源代码

  • #4785：naptered：将字符串添加到翻译文件以进行本地化

  • #4927：当无效值传递给高光指令的线限制选项时显示警告

  • C++：

    • 添加 cpp:texpr 作为兄弟姐妹的角色 cpp:expr .

    • 增加对工会的支持。

    • #3593、#2683：添加对使用名称开头的匿名实体的支持 @ .

    • #5147：添加对（大多数）字符字面量的支持。

    • 支持交叉引用主模板内的实体，并且现在已正确记录。

    • #1552：添加新的交叉引用格式 cpp:any 和 cpp:func 角色，用于引用特定功能过载。

  • #3606：MathJax应加载SEARCH属性

  • html：输出 canonical_url 元数据如果 html_baseurl 集（参考文献：#4193）

  • #5029：自动摘要：暴露 inherited_members 至template

  • #3784：数学题：添加 mathjax_options 为数学题的脚本标签提供选项

  • #726、#969：数学题：添加 mathjax_config 为数学运算提供在线配置，

  • #4362：latex：如果文档未更改，请勿覆盖.tex文件

  • #1431：乳胶：添加字母数字列举列表支持

  • 添加 latex_use_xindy 对于精通UTF-8的索引，默认为 True 如果 latex_engine 是 'xelatex' 或 'lualatex' . (refs：#5134、#5192、#5212）

  • #4976： SphinxLoggerAdapter.info() 现在支持 location 参数

  • #5122：setuptools：支持nitpicky选项

  • #2820：autoclass指令支持嵌套类

  • 添加 app.add_html_math_renderer() 注册HTML的数学渲染器

  • 适用 trim_doctest_flags 致所有构建器（参见。文本、手册）

  • #5140：linkcheck：将更好的接受标头添加到HTTP客户端

  • #4614：Sphinx构建：添加 --keep-going 显示所有警告的选项

  • 添加 math:numref 引用方程的角色（与 eq )

  • 快速启动：默认情况下启用epub构建器

  • #5246：添加 singlehtml_sidebars 为singlehtml builder配置侧边栏

  • #5273：docTest：有条件跳过docTest

  • #5306：autodoc：发出无效类型提示警告

  • #4075、#5215：autodoc：添加 autodoc_default_options 它接受期权价值作为dict

错误已修复

1.8.0b2

  • html：如果滚动，搜索框会覆盖其他元素

  • i18 n：翻译目录的警告具有错误的行号（参考文献：#5321）

  • #5325：乳胶：交叉引用已被多重标签的对象打破

  • C++，修复了符号添加和查找。收件箱不应再在部分构建中中断。另请参阅#5337。

  • #5348：未显示对远程文件的下载引用

  • #5282：html主题： pygments_style 主题被取代 conf.py 默认情况下

  • #4379：当文档被排除时，toctree显示令人困惑的警告

  • #2401：autodoc： :members: 原因 :special-members: 不展示

  • autodoc：对于更深层次的模块，Import错误被Veritas替换

  • #2720、#4034：链接不正确 :download: 、重复名称和并行生成

  • #5290：autodoc：分析鸡蛋包中的源代码失败

  • #5399：如果存在未知po文件，Sphinx会崩溃

1.8.0b1

  • i18 n：每次初始化时都会重置邮件目录

  • #4850：乳胶：脚注内的脚注未呈现

  • #4945：i18 n：修复Index Builder的lang_COUNTRY未正确回退。感谢朱盛景。

  • #4983：productionlist指令为令牌生成无效ID

  • #5132：lualatex：如果索引词以Unicode字符开头，PDF构建失败

  • #5133：乳胶：索引标题“符号”和“数字”未国际化

  • #5114：phinx-Build：处理扫描文档时的错误

  • epub：当toctree上列出“self”时，脊柱已断裂（参考文献：#4611）

  • #344：自动摘要无法理解模块级属性的docstring

  • #5191：C++，防止在函数中嵌套声明，以避免查找问题。

  • #5126：C++，为某些模板参数类型添加缺失的isPack方法。

  • #5187：C++，也解析声明器上的属性。

  • C++，解析删除运算式和基本新运算式。

  • #5002：graphviz：SVG不适应列宽

功能已删除

1.8.0b1

  • sphinx.ext.pngmath 延伸

文件

1.8.0b1

  • #5083：修复错误的make.mat国际化选项。

  • #5115：napathon：将#4613添加的警告添加到文档中。