繁体   English   中英

从 myst-parser markdown 文件中引用(生成的 sphynx 自动文档)python 方法 (:py:meth:)?

[英]Refering to a (sphynx autodoc generated) python method (:py:meth:) from a myst-parser markdown file?

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

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

我试过这个:

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

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

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

使用角色:

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

使用 Markdown 语法:

[the_method](the_module.TheClass.the_method)

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM