在 Sphinx 中引用 python 类时的自定义文本

问题描述

使用 Sphinx 生成我的文档，我可以毫无问题地执行以下操作：

See the deFinition in :py:class:`MyClass`

它按预期工作。

但现在我想使用标准方式为链接使用自定义文本：

See the deFinition in `Custom Text <:py:class:`MyClass`>`

它不起作用。

我无法使用

See the deFinition in `Custom Text<MyClass>`

因为链接指向另一个名为 MyClass 的部分，我不想更改。

明确指出我指的是类而不是节的正确方法是什么？

我想我可以在 MyClass 的定义之前放置一个锚点 .. _myclass:（这是我在另一个文件中手动编写的，它不是 apidoc 生成的）但我想知道我的要求是否可行。

编辑：

我注意到我可以做到：

See the deFinition in :py:class:`Custom text<MyClass>`

并生成带有自定义文本的正确链接。唯一的问题是呈现的文本具有 :py: 引用的格式（有点难看），而不是标准的交叉引用格式（下划线和蓝色的字体类型相同）。

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）