.
repoze.sphinx.autointerface bir Sfenks dokümantasyon sistemi için uzatma & nbsp tanımlar, uzatma kodu zope.interface örneklerinin iç gözlem yoluyla API belgelerine nesil verir.
Kurulum:
Easy_install aracılığıyla yükleyin:
bin / easy_install repoze.sphinx.autointerface
veya PYTHONPATH paketini alır herhangi bir diğer araçlar.
Uzantısı kaydedilmesi
Ürününüz için Sfenks belgelerine conf.py uzantıları listesine repoze.sphinx.autointerface ekleyin. Örn .:
uzantıları = ['sphinx.ext.autodoc'
& Nbsp; 'sphinx.ext.doctest'
& Nbsp; 'repoze.sphinx.autointerface'
& Nbsp;]
Uzantısı kullanma
Belgenize uygun noktalarda, arayüz autodocs aracılığıyla sesleniyorum:
.. Autointerface :: yourpackage.interfaces.IFoo
Direktifin Çıktı içerir
& Nbsp; * tam nitelikli arabirim adı
& Nbsp; * Herhangi bir baz arayüzleri
& Nbsp; * reSTX olarak verilen arayüzü, gelen doctstring.
& Nbsp; * arayüzü üyeleri (yöntemleri ve özellikleri).
& Nbsp; her öznitelik için o çıkış niteliği adını ve açıklamasını içerir.
& Nbsp; Her yöntem için, çıkış yöntemi adı, imza, ve (aynı zamanda reSTX olarak işlenen) kendi docstring'ini içerir o
Bu sürümde Yeni nedir:.
- PyPy uyumluluğu.
- Python 3.2+ uyumluluk. Teşekkürler yama için Arfrever için.
- automodule direktifi altında arayüz belgeler dahil. Yama için Krys Lawrence teşekkürler.
nedir sürüm 0.6.2 Yeni:
Fix TypeError
- : 'NoneType' nesne iterable değil Hata Python 2.7 altında bir arabirim bir render oluştururken.
sürüm 0.6.1 yeni nedir:
- Fix ': üye sırası: bysource' taşıma .
nedir sürüm 0.6 Yeni:
- Doğru ele ': üye:' değerler açıkça set direktifi.
sürüm 0.5 yeni nedir:
- için destek eklendi ': üye sipariş:' bayrak hangi üç hisse değerlerinden birini, & quot alabilir; & quot ;, alfabetik & quot; & quot ;, groupwise veya & quot; & quot ;. bysource Varsayılan olarak, üyeler & quot belgelenmiştir; karma & quot; Sipariş.
Gereksinimler :
- Python
- Sfenks
Yorum Bulunamadı