Sphinx 6.1.3中<pending_xref>标签属性含义咨询(含refdoc默认值)
Sphinx <pending_xref>标签各属性含义解析
升级至Sphinx 6.1.3版本后,<pending_xref>标签的refdoc属性新增了默认值,以下针对示例中的各属性逐一说明具体含义:
<pending_xref py:class="BlobClient" py:module="azure.storage.blob.aio" refdoc="azure.storage.blob.aio" refdomain="py" refspecific="False" reftarget="str" reftype="class">
- py:class:指定待引用的Python类名称,示例中为
BlobClient,明确了要关联的具体类对象。 - py:module:标记该类所属的Python模块,示例里是
azure.storage.blob.aio,用于定位类的归属上下文,帮助解析器缩小查找范围。 - refdoc:定义引用解析时的基准文档/模块,Sphinx 6.1.3后新增默认值,示例中与类所属模块一致,作用是告知解析器以哪个文档的命名空间为基础去查找目标引用。
- refdomain:指定引用所属的领域,这里
py代表Python领域,Sphinx会依据对应领域的规则处理引用解析逻辑。 - refspecific:布尔类型属性,示例中为
False,表示该引用无需针对特定文档版本或上下文做特殊解析,使用通用规则即可。 - reftarget:标记最终要引用的目标对象名称,示例里是
str,即这个待处理引用最终指向的对象。 - reftype:指定引用的类型,示例中为
class,说明这是一个类类型的引用,Sphinx会根据该类型匹配对应的解析规则。
内容的提问来源于stack exchange,提问作者Min Huang
相关产品推荐
相关产品推荐

