python - 让 Sphinx 替换文档字符串文本

Question

我在 Sphinx 中记录类似于这样的代码：

class ParentClass(object):
    
    def __init__(self):
        pass

    def generic_fun(self):
        """Call this function using /run/ParentClass/generic_fun()"""
        do_stuff()

class ChildClass(ParentClass):
    
    def specific_fun(self):
        """Call this function using /run/ChildClass/specific_fun()"""
        do_other_stuff()

我:inherited-members将ChildClass.

有没有办法我可以在像 <class_name> 这样的文档字符串中放入 Sphinx 将替换为它正在记录的实际类的东西？

我想让代码看起来像：

class ParentClass(object):
    
    def __init__(self):
        pass

    def generic_fun(self):
        """Call this function using /run/<class_name>/generic_fun()"""
        do_stuff()

因此，在 ChildClass 部分，Sphinx 文档将显示“(...) using /run/ChildClass/generic_fun()(...)”，而 ParentClass 部分将显示“(...) using /run/ParentClass/ generic_fun()(...)”？

理想情况下，我希望将文档放在同一页面上，因此不同部分的替换字符串会有所不同。

Answer 1

我在看别的东西的同时想出了一种方法。

在打印消息之前，autodoc 会调用一些函数。我将此代码添加到我的 conf.py 文件中：

def get_class_name(full_module_name):
    """
    Pull out the class name from the full_module_name
    """
    #split the full_module_name by "."'s
    return full_module_name.split('.')[-1]

def process_docstring(app, what, name, obj, options, lines):
    classname = get_class_name(name)

    # loop through each line in the docstring and replace |class| with
    # the classname
    for i in xrange(len(lines)):
        lines[i] = lines[i].replace('|class|', classname)

def setup(app):
    app.connect('autodoc-process-docstring', process_docstring)

我想使用 | 令牌，但它们保留用于全局替换。我通过将以下行放在我的第一个文件中解决了这个问题（因此代码用 |class| 替换了 |class|）：

.. |class| replace:: `|class|`