你好
我有一个python模块“example_doc”,其中包含“MyObj”,我正试图使用sphinx来记录它。当我使用'autodoc'和autoclass指令时:
.. autoclass:: testdoc.example_doc.MyObj
它生成带有对象描述的正确页面,并且由于我使用的是“viewcode”sphinx扩展,所以在侧面有一个指向源代码的链接。在
但是,当我试图直接使用class指令来重现结果时:
^{pr2}$我没有找到源代码的链接。在
编辑: 我正在为conda使用最新版本的sphinx,即sphinx1.3.5和 我只是斯芬克斯.ext.autodoc'和'狮身人面像.ext.viewcode'作为我的py配置. 在
使用的代码:
Source link
===========
autodoc below
.. autoclass:: testdoc.example_doc.MyObj
class below
.. class:: testdoc.example_doc.MyObj
结果:
我也有同样的问题。在viewcode扩展中进行了一些调试,以找出使用autodoc和手动声明内容之间的区别之后,我发现可以通过在所有类之前分别声明模块来使其工作。在
也就是说,与其这样做:
这样做:
^{pr2}$我不确定这是一个bug还是预期的行为,但是不管怎样,显式声明模块使
[source]
链接出现。在相关问题 更多 >
编程相关推荐