定义自己的Sphinx信息字段

时间:2018-08-06 09:06:57

标签: python-sphinx restructuredtext

在文档生成期间,我们可以在文档字符串中编写一些变量(info fields),例如rtypereturnparam

有人知道如何定义自己的变量来写这样的东西吗?

def foo():
    """
    The most useless function ever

    :my_own_variable: Wow such function!
    :return: None
    """

    return None  

该预期结果-在尚未生成的html格式文档中新突出显示的字段。

0 个答案:

没有答案