Sphinx2.4

版本2.4.5(2021年11月18日发布)

依赖关系

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

版本2.4.4(2020年3月5日发布)

错误已修复

  • #7197:LaTeX:Platex导致使用目标URL构建图像指令时出错

  • #7223:自2.4.0以来,Sphinx构建速度较慢

版本2.4.3(2020年2月22日发布)

错误已修复

  • #7184:autodoc: *args**kwarg 类型评论处理不当

  • #7189:autodoc:未检测到类方法协程

  • #7183:狮身 :attr: 对属性的引用已被破坏

  • #6244,#6387:html搜索:使用dirhtml构建器构建时搜索中断/挂起

  • #7195:todo:错误地发出具有非文档节点的文档树解析事件

版本2.4.2(2020年2月19日发布)

错误已修复

  • #7138:autodoc: autodoc.typehints 当变量将未绑定对象作为值时崩溃

  • #7156:autodoc:未显示仅关键字参数的分隔符

  • #7146:autodoc:IndexError is raised on suppressed type_comment found

  • #7161:autodoc:typehits扩展不支持并行构建

  • #7178:autodoc:获取类型注释时会引发TypHelp

  • #7151:当扩展将值赋给时崩溃 env.indexentries

  • #7170:文本:删除调试打印

  • #7137:viewcode:避免在给定非Python代码时崩溃

版本2.4.1(2020年2月11日发布)

错误已修复

  • #7120:html:缩放具有浮动维度的JPEG图像时崩溃

  • #7126:autodoc:TypeError:'getset_descriptor'对象不可迭代

版本2.4.0(2020年2月9日发布)

弃用

  • decode 论点 sphinx.pycode.ModuleAnalyzer()

  • sphinx.directives.other.Index

  • sphinx.environment.temp_data['gloss_entries']

  • sphinx.environment.BuildEnvironment.indexentries

  • sphinx.environment.collectors.indexentries.IndexEntriesCollector

  • sphinx.ext.apidoc.INITPY

  • sphinx.ext.apidoc.shall_skip()

  • sphinx.io.FiletypeNotFoundError

  • sphinx.io.get_filetype()

  • sphinx.pycode.ModuleAnalyzer.encoding

  • sphinx.roles.Index

  • sphinx.util.detect_encoding()

  • sphinx.util.get_module_source()

  • sphinx.util.inspect.Signature

  • sphinx.util.inspect.safe_getmembers()

  • sphinx.writers.latex.LaTeXTranslator.settings.author

  • sphinx.writers.latex.LaTeXTranslator.settings.contentsname

  • sphinx.writers.latex.LaTeXTranslator.settings.docclass

  • sphinx.writers.latex.LaTeXTranslator.settings.docname

  • sphinx.writers.latex.LaTeXTranslator.settings.title

  • sphinx.writers.latex.ADDITIONAL_SETTINGS

  • sphinx.writers.latex.DEFAULT_SETTINGS

  • sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG

  • sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG

  • sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG

  • sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG

功能添加

  • #6910:继承_图表:使图表的背景透明

  • #6446:持续时间:添加 sphinx.ext.durations 检查哪些文件会减慢构建速度

  • #6837:LaTeX:支持嵌套表

  • #7115:LaTeX:允许通过环境变量覆盖LATEXOPTS和LATEXMKOPTS

  • #6966:graphviz:支持 :class: 选项

  • #6696:html: :scale: 图像/图形指令选项不适用于JPEG图像(需要imagesize-1.2.0或更高版本)

  • #6994:imgconverter:支持插画文件(.ai)到.png转换

  • autodoc:支持仅位置参数分隔符(PEP-570兼容)

  • autodoc:支持变量的类型注释

  • #2755:autodoc:添加新事件: autodoc-before-process-signature

  • #2755:autodoc:支持类型_评论风格(例如。 # type: (str) -> str )注释(python3.8+或 typed_ast 是必需的)

  • #7051:autodoc:支持不带默认值的实例变量(PEP-526)

  • #6418:autodoc:添加新扩展 sphinx.ext.autodoc.typehints .如果出现以下情况,它将typehints显示为对象描述 autodoc_typehints = "description" 集这是一个实验性扩展,将集成到Sphinx 3.0中的autodoc核心中

  • 如果未找到原始节点类的访问者/离开方法,SphinxTranslator现在调用超级节点类的访问者/离开方法

  • #6418:添加新事件: object-description-transform

  • py域: py:datapy:attribute 采取新的选项, :type::value: 描述其类型和初始值

  • #6785:py域: :py:attr: 能够再次引用属性

  • #6772:apidoc:添加 -q 静音模式选项

错误已修复

  • #6925:html:从元素中删除多余的类型=“text/JavaScript”<script>

  • #7112:html:即使对齐,即使即使JPEG图像也不会布局为浮动

  • #6906,#6907:autodoc:无法读取cp 1251中编码的源代码

  • #6961:乳胶:巴别塔警告显示两次

  • #7059:latex:LaTeX编译陷入无限循环(wrappig问题)

  • #6581:乳胶: :reversed: toctree选项不影响LaTeX构建

  • #6559:术语表指令中生成错误的节点ID

  • #6986:apidoc:错误检测到模块内的.so文件的模块名称

  • #6899:apidoc:即使在 --private 给定

  • #6327:apidoc:支持由以下内容组成的Python包 __init__. so文件

  • #6999:naps:无法解析:exc:role中的波浪号

  • #7019:gettext:消息目录中使用的绝对路径

  • #7023:autodoc:未列出嵌套部分函数

  • #7023:autodoc:从其他模块导入的部分函数被列为模块成员,不带:imported-memberships:选项

  • #6889:autodoc:尾部逗号 :members:: 选项引发神秘警告

  • #6568:自动摘要: autosummary_imported_members 在为子模块生成存根文件时忽略

  • #7055:linkcheck:重定向被视为错误

  • #7088:HTML模板:如果 navigation_with_keys 选项被激活,修改键被忽略,这意味着该功能可能会干扰浏览器功能

  • #7090:std域:无法为自定义容器节点分配numfig-number

  • #7106:std域:扩展调用时,列举的节点被标记为重复 note_explicit_target()

  • #7095:dirhtml:交叉引用通过interphinx和 :doc: 作用

  • C++:

    • 使用时不要崩溃 struct 在某些情况下的作用。

    • 使用时不要警告 var/member 函数参数的角色。

    • 正确渲染调用和花括号初始化表达。

  • #7097:由生成的图像的文件名 sphinx.transforms.post_transforms.images.ImageConverter 或它的子类(用于乳胶构建)现在被消毒,以防止损坏的路径