在自动生成的文档字符串中使用Sphinx方法

时间:2018-11-21 14:13:04

标签: python-3.x python-sphinx

我开始熟悉Sphinx作为代码文档生成器。它使笨拙的过程变得更加流畅,不过,我仍然对如何使用该工具正确地做事存有疑问。

我现在想要实现的是。在我的文档字符串中放置指向某些函数的链接。就是

  

波兰所有紧急电话的列表(用于is_foreign()方法)

,我想设置该方法的链接,因此当有人单击它时,将显示该方法的文档。我知道您可以使用.rst文件来做这些事情,但是..如果我的.rst文件主要是自动生成的,我该如何处理这些事情?我不仅在谈论这种链接情况,而且还谈论诸如在特定方法内插入图像之类的任何事情。

处理此问题的唯一方法是手动创建每个需要特殊处理的方法的条目吗?如果是这样:如何将其排除在自动生成之外?

提前感谢任何提示和技巧。

0 个答案:

没有答案