Я документирую код в 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 документация, поэтому у меня есть такие предложения, как & quot; вызов этой функции с помощью / run / ParentClass / generic_fun () & quot ;.

Есть ли способ, которым я могу поместить что-то в строки документации, например, sphinx заменит реальный класс, который он документирует?

Я хотел бы, чтобы код был похож     Класс ParentClass (объект):

    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 () ...?

В идеале я хотел бы, чтобы документация была на одной странице, поэтому строка замены для разных разделов будет разной.