我正在尝试使用Sphinx来记录项目,但我无法弄清楚如何使用 intersphinx。我用这句话:
:py:meth:`math.sin`
添加链接,但在输出中,它显示为粗体,而不是链接。 虽然该行不起作用,但以下都是:
:py:meth:`dict.items`
:py:class:`zipfile.ZipFile`
conf.py文件中的intersphinx_mapping值为:
intersphinx_mapping = {'python':('http://docs.python.org/2.7', None)}
答案 0 :(得分:8)
:py:meth:
应为:py:func:
。基本上,
可以使用任何有效的domain。
答案 1 :(得分:5)
您是否阅读了intersphinx的文档?
修改强>
使用它可以工作:
***
TRY
***
My try
======
sin
:py:func:`math.cos`
pop
:py:meth:`dict.pop`
dict
:py:meth:`dict.items`
zipfile
:py:class:`zipfile.ZipFile`
在此处阅读crossreference
中的结构