sfenks metni

Question

bu andıran

ben Sfenks kod belgeleyen am docstringe replace mı:

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

Ben ChildClass belgelerine :inherited-members eklendi, böylece orada gibi ifadeleri var "/ ParentClass çalıştırmak/kullanarak bu işlevi çağırın/generic_fun()".

Sfenksin, belgelediği gerçek sınıfla yer değiştirmesi gibi bir şeyleri dizine koymamın bir yolu var mı?

Ben sınıf ParentClass (nesne) gibi kod göz atmak istiyorum

: Yani

def __init__(self): 
     pass 

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

ChildClass bölümünde, Sfenks belgelerine okurdum ... kullanarak/run/ChildClass/generic_fun() ... ve ParentClass bölümü okuyacaktır .../run/ParentClass/generic_fun() kullanarak ...?

İdeal olarak, aynı sayfadaki belgelere sahip olmak isterim, böylece yedek dizge farklı bölümler için farklı olurdu.

Answer 1

Başka bir şeye bakarken bunu yapmanın bir yolunu buldum.

İleti yazdırmadan önce autodoc'un çağrılacağı işlevler vardır. Bu kodu conf.py dosyama ekledim:

Kullanmak istiyorum | belirteci, ancak global ikameler için ayrılmıştır. Bu satırda aşağıdaki satırı ekledim (bu yüzden kod | sınıf | | | | | | | | | sınıf | sınıf |) |

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