Sphinx3.5

版本3.5.4（2021年4月11日发布）

依赖关系

  • #9071：将Docutils限制为0.16

错误已修复

  • #9078：autodoc：异步静态方法和类方法被认为是Python 3.10的非可编程协程函数

  • #8870，#9001，#9051：html主题：Docutils 0.17不适用样式

    • 托特里字幕

    • 的内容 sidebar 指令

    • 图

版本3.5.3（2021年3月20日发布）

功能添加

  • #8959：在图像指令中使用UNix路径分隔符会混淆Windows上的Sphinx

版本3.5.2（2021年3月6日发布）

错误已修复

  • #8943：i18 n：因ES、EL和HR中的翻译消息损坏而崩溃

  • #8936：LaTeX：自定义LaTeX构建器失败，出现未知节点错误

  • #8952：指令中提出的警告导致并行构建挂起

版本3.5.1（2021年2月16日发布）

错误已修复

  • #8883：autodoc：分配时会引发Veritas错误 __annotations__ 在只读类上

  • #8884：html：小型js stemmers不包括在分发包中

  • #8885：html：如果通过安装CSS/JS文件，则会引发Veritas错误 html_context

  • #8880：viewcode：发现不可分析的Python模块后，增量构建时会引发Extension错误

版本3.5.0（2021年2月14日发布）

依赖关系

  • LaTeX： multicol (it无论如何，这是官方latex 2e基础分发的必需部分）

不兼容的更改

弃用

  • 视图代码扩展的pending_xref节点

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.good

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers

  • sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue

  • sphinx.builders.linkcheck.node_line_or_0()

  • sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()

  • sphinx.ext.autodoc.directive.DocumenterBridge.reporter

  • sphinx.ext.autodoc.importer.get_module_members()

  • sphinx.ext.autosummary.generate._simple_info()

  • sphinx.ext.autosummary.generate._simple_warn()

  • sphinx.writers.html.HTMLTranslator.permalink_text

  • sphinx.writers.html5.HTML5Translator.permalink_text

功能添加

  • #8022：autodoc：autodata和autoattribute指令不显示变量的右侧值，如果docstring包含 :meta hide-value: 在信息字段列表中

  • #8514：autodoc：如果重载函数是省略号，则从实际实现中获取默认值

  • #8775：autodoc：Python 3.10或更高版本中支持类型联合运算符（PEP-604）

  • #8297：autodoc：允许扩展 autodoc_default_options 通过指令选项

  • #759：autodoc：添加新配置 autodoc_preserve_defaults 作为实验特征。 它保留源代码中函数的默认参数值，并保持不评估它们的可读性。

  • #8619：html：kbd role generates customizable HTML tags for compound keys

  • #8634：html：允许通过更改JS/CSS的顺序 priority 参数 Sphinx.add_js_file() 和 Sphinx.add_css_file()

  • #6241：html：允许在扩展调用时将JS/CSS文件添加到特定页面 app.add_js_file() 或 app.add_css_file() 对 html-page-context 事件

  • #6550：html：允许通过使用HTML永久链接文本 html_permalinks_icon

  • #1638：html：将永久链接图标添加到术语表术语

  • #8868：html搜索：大量列表的性能问题

  • #8867：html搜索：将JavaScript茎分析器代码更新到Snowball的最新版本（v2.1.0）

  • #8852：i18n：允许在MyST解析器中翻译标题语法

  • #8649：imgconverter：如果构建器支持图像类型，则跳过可用性检查

  • #8573：napplying：允许更改自定义部分的样式使用 napoleon_custom_sections

  • #8004：naplogy：Google样式文档字符串中的类型定义在以下情况下呈现为引用 napoleon_preprocess_types 启用

  • #6241：mathspel：仅在使用方程式的文档中包含mathjax.js

  • #8775：py域：支持类型联合运算符（PEP-604）

  • #8651：std域：具有内联项的标题的交叉引用被破坏

  • #7642：std域：优化术语的不区分大小写匹配

  • #8681：viewcode：支持增量构建

  • #8132：添加 project_copyright 作为的别名 copyright

  • #207：现在 highlight_language 支持多种语言

  • #2030： code-block 和 literalinclude 支持通过无参数自动dedent :dedent: 选项

  • C++，超链接操作符也会在表达和别名声明中重载。

  • #8247：允许生产列表引用来自其他生产组的令牌

  • #8813：显示是哪个扩展（或模块）导致事件处理程序出现错误

  • #8213：C++：添加 maxdepth 选项 cpp:alias 插入嵌套声明。

  • C、添加 noroot 选项 c:alias 仅呈现嵌套声明。

  • C++，add noroot 选项 cpp:alias 仅呈现嵌套声明。

错误已修复

  • #8727：apidoc：如果没有子模块，则不会生成命名空间模块文件

  • #741：autodoc：inherited-members不适用于超类上的实例属性

  • #8592：autodoc： :meta public: 不影响变量

  • #8594：autodoc：空 __all__ 属性被忽略

  • #8315：autodoc：无法解析结构。结构类型注释

  • #8652：autodoc：如果模块包含无效的类型注释，则忽略模块中的所有变量注释

  • #8693：autodoc：重载函数的默认值呈现为字符串

  • #8134：autodoc：当被模仿的装饰者接受参数时崩溃

  • #8800：autodoc：超类中未初始化的属性被识别为未记录的属性

  • #8655：autodoc：如果目标模块包含引发异常的对象，则无法生成文档 hasattr()

  • #8306：autosummary：使用：recursive：选项时被模拟的模块记录为空页面

  • #8232：graphviz：如果图形文件位于收件箱中，则不会渲染图像节点

  • #8618：html：kbd角色将复合键分隔符（-、+或'）用作星号时生成不正确的HTML

  • #8629：html：html_use_opensearch的类型警告显示两次

  • #8714：html：带有“Caps Lock”的kbd角色呈现错误

  • #8123：html搜索：修复搜索包含+的术语的问题（需要不会在+上分裂的自定义搜索语言）

  • #8665：html主题：无法覆盖theme. inf中的globaltoc_max深度

  • #8446：html：连续的空间显示为单个空间

  • #8745：i18 n：当翻译消息添加新的自动脚注引用时，崩溃并出现KeyMessage

  • #4304：linkcheck：修复可能导致检查同一URL可用性两次的竞争条件

  • #8791：linkcheck：不显示每个超链接的文档名

  • #7118：Sphinx-快速启动：如果libreadline不可用，则会收到Mojibake问卷

  • #8094：texinfo：不复制带有文档的不同目录上的图像文件

  • #8782：todo：todolist中的交叉引用被打破

  • #8720：viewcode：在增量构建时为epub生成模块页面

  • #8704：viewcode：在singlehtml之后增量构建中生成锚点

  • #8756：viewcode：即使没有引用，也会生成突出显示的代码

  • #8671： highlight_options 不工作

  • #8341：C，修复声明中名称的interphinx查找类型。

  • C、C++：一般修复interphinx和角色查找类型。

  • #8683： html_last_updated_fmt 不支持UTC偏差（%z）

  • #8683： html_last_updated_fmt 为%Z生成错误的时区

  • #1112： download 指定相对路径时，角色创建重复副本

  • #2616（第五项）：LaTeX：标题中的脚注不可点击，对于手动编号的脚注，只有第一个具有相同编号的脚注是超链接

  • #7576：带有法语巴别语和回忆录崩溃的LaTeX：“定义中的参数号非法 \FNH@prefntext "

  • #8055：LaTeX（文档）：Sphinx中LaTeX生成步骤的潜在显示错误（如何生成一列索引）

  • #8072：LaTeX：指令 hlist 未在LaTeX中实现

  • #8214：LaTeX：The index 角色和术语表在LaTeX索引中生成重复条目（如果两者都用于同一术语）

  • #8735：LaTeX：pdf中错误的内部链接到标题代码块时 numfig 不 True

  • #8442：LaTeX：使用xelatex引擎（或pdflatex和 latex_use_xindy 设置为 True ）带回忆录课

  • #8750：LaTeX：如果来自内部函数类型签名，则作为脚注的URL无法在PDF中显示

  • #8780：LaTeX：窄列中的长字可能不带有连字符

  • #8788：LaTeX： \titleformat phinx.sty中的最后一个参数应该放在括号中，而不是放在括号中（而且无论如何都不需要）

  • #8849：LaTex：代码块打印在页边空白处（请参阅选择加入LaTeX语法布尔值 verbatimforcewraps 供通过 'sphinxsetup' 关键 latex_elements )

  • #8183：LaTeX：仅在LaTeX构建版本上从doctree中删除substitution_reference节点

  • #8865：LaTeX：仅在LaTeX构建中重新结构标题节点内的索引节点

  • #8796：LaTeX：潜在严重的低级TeX编码错误迄今为止尚未被注意到

  • C， c:alias 跳过没有明确声明的符号，而不是崩溃。

  • C， c:alias 当未声明根符号时发出警告。

  • C， expr 角色应在当前范围中开始符号查找。