如何在父 class 文档字符串中引用子 class 属性？

Question

我正在使用:inherited-members:来显示父方法。

在为孩子生成的文档中，是否可以参考孩子 class？

class Parent:
   """This is a {Child class name} class

   This is in the {Child group attribute} group
   """
   group = ''
   ...

class Child(Parent):
   group = 'TheChild'
   ...

在为孩子生成的文档中，我希望看到：

> class Child(Parent)
>   Bases: Parent
>   This is a Child class.
>   It is in the TheChild group

狮身人面像有可能吗？

Answer 1

您可以在文档字符串中使用 Sphinx 交叉引用语法，以及来自Python 域的适当角色。 之后，您的.rst中的autodoc 指令会处理 rest。

示例 parent_child.py

class Parent:
    """
    This is a :py:class:`Child` class.

    This is in the :py:data:`Child.group` attribute.
    """
    group = 'TheParent'


class Child(Parent):
    group = 'TheChild'

parent_child.rst

Parent\_Child
=============

.. autoclass:: parent_child.Parent
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: parent_child.Child
    :members:
    :undoc-members:
    :show-inheritance:

结果：