Python Sphinx automodule:如何引用同一模块中的类?
我正在尝试使用sphinx扩展,特别是Python Sphinx automodule:如何引用同一模块中的类?,python,django,python-sphinx,autodoc,Python,Django,Python Sphinx,Autodoc,我正在尝试使用sphinx扩展,特别是automodule指令,为我正在开发的django应用程序自动生成文档。问题是我想在模块中创建不同类的内部引用,而不必在项目中的每个类/函数上使用autoclass和autofunction。对于这样的源文件: # source_code.py class A: """docs for A """ pass class B: """docs for B with :ref:`internal reference
automodule
指令,为我正在开发的django应用程序自动生成文档。问题是我想在模块中创建不同类的内部引用,而不必在项目中的每个类/函数上使用autoclass
和autofunction
。对于这样的源文件:
# source_code.py
class A:
"""docs for A
"""
pass
class B:
"""docs for B with
:ref:`internal reference to A <XXXX-some-reference-to-A-XXXX>`
"""
pass
.. automodule: source_code
class B(object):
"""docs for B with reference to :class:`.A`"""
pass
对于XXXX-some-reference-to-A-XXXX,我可以使用什么参考?有没有一个简单的方法来实现这一点?提前感谢您的帮助。我不知道我是否理解这个问题,但根据
类流向(通用表):
'''
热流方向
:cvar int id:数据库主键
:cvar unicode名称:名称
'''
定义报告(自我):
返回u“”。格式为(
self.name,十六进制(id(self)).encode('utf-8'))
def ___; unicode(自):
返回self.name
类空腔(通用):
'''
空气腔:术语:`热阻`
:cvar流动方向:热流方向
(参见:类:`FlowDirection`)
:cvar int id:数据库主键
:cvar int if_fd:database外键to:class:`FlowDirection`
:cvar浮子res::术语:`热阻`
:cvar浮子厚度:厚度
'''
定义报告(自我):
返回u“”。格式为(
self.res,十六进制(id(self)))
您可以引用这样的类:
# source_code.py
class A:
"""docs for A
"""
pass
class B:
"""docs for B with
:ref:`internal reference to A <XXXX-some-reference-to-A-XXXX>`
"""
pass
.. automodule: source_code
class B(object):
"""docs for B with reference to :class:`.A`"""
pass
斯芬克斯将智能地尝试并找出您所引用的内容。如果有多个名为A
的类,您可能会收到一条警告,但它应该选择当前模块中的一个