使用Sphinx交叉引用与intersphinx无法识别Python常量(True/False/None)
解决Sphinx intersphinx无法引用Python核心常量(True/False/None)的问题
我之前也踩过这个坑!问题出在True、False和None在Python官方文档里的角色分类——它们并不是:py:const:类型,而是属于:py:obj:角色范畴(本质上True和False是bool类的实例,None是NoneType的唯一实例)。
你只需要把引用的角色从:py:const:换成:py:obj:就可以解决这个问题:
- 把
:py:const:True改成`:py:obj:`True - 把
:py:const:False改成`:py:obj:`False - 把
:py:const:None改成`:py:obj:`None
你的intersphinx配置是完全没问题的,因为你已经正确映射了Python 3.6的文档源。修改角色后,Sphinx就能通过intersphinx找到这些核心常量对应的官方文档链接了。
举个实际的写法例子:
函数返回值为:py:obj:`True`表示验证通过,返回:py:obj:`False`表示验证失败,特殊情况返回:py:obj:`None`。
这样编译后的文档里,这三个常量都会生成指向Python官方文档对应部分的超链接啦。
内容的提问来源于stack exchange,提问作者El Laggron
相关产品推荐
相关产品推荐

