function 或 class 在 Sphinx 中的 Python 的交叉参考文档

Question

我想在解释性文档中引用 Python class 的文档，稍后再引用它的构造函数。 所以想象有一个文件

# MyLib/MyClass.py
class MyClass:
    """Class Introduction"""
    def __init__(paramX):
        """:param paramX: Xes out things"""

和我的第一个文件

#MyLib/docs/source/MyDoc.rst
Some text where :ref:`here` is my reference to "Class Introduction"
 and :ref:`there` follows my reference to the __init__ method documentation

如何让参考工作：我需要如何以及在 Sphinx 文件中的何处包含 Python 文件以及如何定义（在 Python 文件中）和解析（在第一个文件中）参考？ 预期的 output 将是这样的：

Some text where <link to documentation of class _MyClass_>...
 and 
    'class MyClass
        def __init__(paramX):
           paramX: Xes out things'

如前所述，括号 <..> 包含文档链接，文档本身出现在“和”之后，在第一个文件中分别由:ref:`here`和:ref:`there` 。

Answer 1

从问题中的示例模块ref_constructor.py

class MyClass:
    """Class Introduction."""
    def __init__(paramX):
        """The docstring of constructor.

        :param paramX: Xes out things.
        :type paramX: str
        """

使用 reST 文件ref_constructor.rst小心选择适当的角色，在本例中为:class:和:meth:

Reference to class constructor
------------------------------

.. automodule:: ref_constructor


.. here begins de documentation.

Some text where :class:`ref_constructor.MyClass` is my reference to "Class Introduction"
and :meth:`ref_constructor.MyClass.__init__` follows my reference to the __init__ method documentation.


Some text where :class:`MyClass` is my reference to "Class Introduction"
and :meth:`MyClass.__init__` follows my reference to the __init__ method documentation.

您可以根据上下文使用完全限定名称或缩短的 forms 编写交叉引用

交叉引用 Python 对象

此标记中包含的名称可以包括模块名称和/或 class 名称。 例如， :py:func:`filter`可以引用当前模块中名为过滤器的 function 或该名称的内置 function。 相比之下， :py:func:`foo.filter`显然是指 foo 模块中的过滤器 function。

结果