Sphinx automodule：如何引用同一模块中的类？

Question

我正在尝试使用 sphinx autodoc 扩展，特别是

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

我希望能够有一个像这样的 sphinx 文档文件：

.. automodule: source_code

对于 XXXX-some-reference-to-A-XXXX，我可以使用什么参考？有没有一种简单的方法可以实现这一点？预先感谢您的帮助。

Answer 1

你可以引用这样的类：

class B(object):
    """docs for B with reference to :class:`.A`"""
    pass

Sphinx 会智能地尝试找出您所引用的内容。如果有多个名称为

A

的类，您可能会收到警告，但它应该选择当前模块中的一个。

Answer 2

不知道我是否理解这个问题，但这对我来说用autodoc完美地工作，按照交叉引用Python对象

class FlowDirection(GeneralTable):
    '''
    Heat Flow Direction
    
    :cvar int id: database primary key
    :cvar unicode name: name 
    '''
    def __repr__(self):
        return u'<FlowDirection {0} instance at {1}>'.format(
                self.name, hex(id(self))).encode('utf-8')

    def __unicode__(self):
        return self.name

class AirCavityRes(GeneralTable):
    '''
    Air Cavity :term:`thermal resistance`

    :cvar flow_direction: heat flow direction
        (see :class:`FlowDirection`)
    :cvar int id: database primary key
    :cvar int if_fd: database foreign key to :class:`FlowDirection`
    :cvar float res: :term:`thermal resistance`
    :cvar float thick: thickness
    '''
    def __repr__(self):
        return u'<AirCavityRes {0} instance at {1}>'.format(
                self.res, hex(id(self)))