Python Sphinx文档字符串 - 多次引用参数块

时间:2018-01-31 01:17:53

标签: python python-sphinx docstring

我有多个类都有他们继承的基础。 __init__每个参数都有很多基本相同的参数。在文档字符串中是否存在sphinx只能编写一次param定义,然后在其他地方引用?

例如:

:param str a: Opt A
:param str b: Opt B
:param str c: Opt C

在从基类继承的所有类中,我想要相同的param块,如上所示。我想要这样做的主要原因是,实际上有十几个或更多的参数,它们将来可能会发生变化。我想只在一个地方更新它们。

0 个答案:

没有答案