在Sphinx中引用没有完整类名的Python方法文档

Question

我正在尝试引用

http://docs.python.org/2.7/reference/datamodel.html#object.__enter__

来自我的python Sphinx文档，并希望文档中的链接看起来像func :func:角色，如果__enter__在当前类中实现（即，以相同的样式）并且只是 __enter__ 而不是 object.__enter__ 。

有没有办法实现这个目标？

Answer 1

如果您设置了intersphinx，则以下标记将在Python文档中生成指向指定目标的超链接，其链接文本为 __enter__ ：

:meth:`__enter__ <object.__enter__>`

替代方案：

:meth:`~.object.__enter__`

这将生成链接文本__enter__()（默认情况下带括号;请参阅http://sphinx-doc.org/config.html#confval-add_function_parentheses）。

或者只是使用它：

 

`__enter__ <http://docs.python.org/2.7/reference/datamodel.html#object.__enter__>`_

请参阅http://sphinx-doc.org/markup/inline.html#cross-referencing-syntax和http://sphinx-doc.org/rest.html#hyperlinks。