python - Intersphinx Docstring 可读性

Question

Intersphinx 是一个非常好的工具，可以将交叉引用放入包文档中。然而，一个问题是，这些交叉引用的编写方式会导致在help(function)终端或function?jupyter-notebook 中阅读时文档字符串的易读性降低。

考虑以下示例：

def time2int(ds: Series) -> Series:
    """Convert :class:`~pandas.Series` encoded as 
    :class:`~numpy.datetime64` or :class:`~numpy.timedelta64` to :class:`int`

    Parameters
    ----------
    ds: Series

    Returns
    -------
    Series
    """

请注意，由于有类型别名，参数和返回类型实际上不需要:class:`~pandas.前缀：

napoleon_type_aliases = {
    "Series" : "~pandas.Series"
}

是否有一种简单的方法可以为文档字符串的函数描述部分实现相同的功能？理想情况下，我希望有一种方法可以定义一个宏，以尽可能减少文档字符串中的噪音（=非内容字符）。如果可以定义宏/交叉引用，以便我们可以编写Series_或:Series:或类似的东西来代替:class:`~pandas.Series` 并获得相同的格式，那将是一个巨大的改进。