引用 myst-parser markdown 文件中的（sphynx autodoc 生成的）python 方法 (:py:meth:)？

Question

我有一段由 sphinx :autoclass: 指令生成的 sphinx 文档

我想引用 mystmarkdown 文件中 python 方法的（文档字符串）生成的文档

来自

我试过这个：

{:py:meth:}

the_module.TheClass.the_method

但生成的文档没有超链接，仅突出显示

the_module.TheClass.the_method

Answer 1

根据 MyST 文档，您将使用以下语法。

使用角色

{py:meth}`the_module.TheClass.the_method`

或者如果您想为该方法指定一个更短的名称：

{py:meth}`the_method <the_module.TheClass.the_method>`

请注意，开头的

py:

是可选的。

使用 Markdown 语法

[the_method](the_module.TheClass.the_method)

两种语法的区别

使用

{meth}`foo`

（角色语法）的优点是它保留了链接的语义，并应用所需的 CSS 来将其与常规链接区分开来。