Nasıl'dilerseniz sözü'in a sınıfı belge için s Sfenks kullanın ____(self) yöntemi init?
Sfenks varsayılan olarak __init__(self) için belgeler oluşturmak değildir. Aşağıdaki denedim:
.. automodule:: mymodule
:members:
ve
..autoclass:: MyClass
:members:
İçinde conf.py ayar aşağıdaki sadece ekler __init__(self) kütüphane sınıf Fibonacci sayıları (the Sphinx autodoc documentation gibi kabul eden bu beklenen davranış, ama söz edilen şey ile ilgili sorunu çözmeye çalışıyorum):
autoclass_content = 'both'
CEVAP
Burada üç seçenek var:
__init__()
Her zaman belgelenmiş olduğundan emin olmak için, conf.pyautodoc-skip-member
kullanabilirsiniz. Bu gibi:def skip(app, what, name, obj, skip, options): if name == "__init__": return False return skip def setup(app): app.connect("autodoc-skip-member", skip)
Bu açıkça
__init__
atlanması değil (varsayılan) tanımlar. Bu yapılandırma bir kez belirtilir, ve her sınıf için herhangi bir ek biçimlendirme gerektirmez .ilk kaynak.special-members
seçeneği added in Sphinx 1.1. "Üyeler (__special__
gibi isimleri olanlar) dilerseniz sözü. tarafından belgelenen "özel yapıyorSfenks beri 1.2, bu seçenek onu daha önce olduğundan daha yararlı kılan argüman alır.
automethod
:.. autoclass:: MyClass :members: .. automethod:: __init__
Bu her sınıf (bu cevap ilk Gözden Geçirme için bir yorumda belirttiği gibi
automodule
ile kullanılabilir) eklenmelidir.
Nasıl düzgün S4 sınıfı yuvaları Roxyge...
Nasıl Yansıma Aşırı bir Yöntemi Çağırm...
Nasıl Python belge sınıfı için öznitel...
Nasıl özel yöntemleri, alanları veya i...
Nasıl tam ve git deposu init ile oluşt...