如何在Sphinx中添加源代码链接

时间:2018-01-17 10:14:33

标签: python-sphinx

enter image description here

class torch.FloatStorage[source]
    byte()
        Casts this storage to byte type
    char()
        Casts this storage to char type

我试图完成一些文档,我设法得到如上所示的格式,但我不知道如何给出该函数末尾的源代码链接! 该链接将此人带到包含代码的文件,但我不知道该怎么做,

1 个答案:

答案 0 :(得分:1)

这是通过内置的sphinx扩展之一实现的。

您在spinx.ext.viewcode中寻找的那个。要启用它,请将字符串'sphinx.ext.viewcode'添加到extensions文件中的列表conf.py

总之,您应该在conf.py

中看到类似的内容
extensions = [
    # other extensions that you might already use
    # ...
    'sphinx.ext.viewcode',
]