【问题标题】:Refering to a (sphynx autodoc generated) python method (:py:meth:) from a myst-parser markdown file?从 myst-parser markdown 文件引用(sphinx autodoc generate)python 方法(:py:meth :)?
【发布时间】:2022-11-26 19:59:36
【问题描述】:

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

我想从 mystmarkdown 文件中引用 python 方法的(docstring)生成的文档

我试过这个:

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

但是生成的文档没有超链接,只高亮了the_module.TheClass.the_method

【问题讨论】:

    标签: python-sphinx myst


    【解决方案1】:

    根据MyST documentation,您将使用以下语法。

    使用角色:

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

    使用 Markdown 语法:

    [the_method](the_module.TheClass.the_method)
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2022-01-06
      • 2012-05-09
      • 2020-09-28
      • 2020-09-25
      • 2016-07-24
      • 1970-01-01
      • 2011-04-10
      • 1970-01-01
      相关资源
      最近更新 更多