如何使用Intersphinx从特定文档中引用类?

时间:2015-09-27 20:06:50

标签: python documentation python-sphinx

我为Python 2和Python 3的文档设置了Intersphinx - 映射:

intersphinx_mapping = {'py2': ('http://docs.python.org/', None),
                       'py3': ('http://docs.python.org/3', None)}

如何从这两种资源的特定类中引用一个类?该文档仅提及:ref:个,而这两个尝试不起作用:

:ref:`collections.Mapping <py2:collections.Mapping>`
:class:`py3:collections.Mapping`

虽然这会产生预期的链接:

:class:`collections.Mapping`

1 个答案:

答案 0 :(得分:3)

下面的标记会为您的intersphinx_mapping配置生成工作链接(对于py2,我建议您将网址更改为http://docs.python.org/2以使版本明确。)

 

Python 2:

:class:`py2:collections.Mapping`

Python 3(Mapping在Python 3.3中被移动到collections.abc

:class:`py3:collections.abc.Mapping`