开发者

How can I put an intersphinx link to an arbitrary method in the standard library documentation?

开发者 https://www.devze.com 2023-03-08 14:51 出处:网络
I am trying to use Sphinx to document a project, but I cannot figure out how to use intersphinx.I use this line:

I am trying to use Sphinx to document a project, but I cannot figure out how to use intersphinx. I use this line:

:py:meth:`math.sin`

to add the link, but in the output, it shows up bold, not as a link. A开发者_Python百科lthough that line does not work, both the following do:

:py:meth:`dict.items`
:py:class:`zipfile.ZipFile`

My intersphinx_mapping value in the conf.py file is:

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


The :py:meth: should be :py:func:. Basically, any valid domain can be used.


Have you read the documentation for intersphinx?

Edit

Got it to work using this:

***
TRY
***

My try
======

sin
:py:func:`math.cos`

pop
:py:meth:`dict.pop`

dict
:py:meth:`dict.items`

zipfile
:py:class:`zipfile.ZipFile`

Read about the constructs here crossreference

0

精彩评论

暂无评论...
验证码 换一张
取 消