2013-01-02 19 views
9

Olası Çoğalt:
Sphinx — combining automodule and autoclassPython: Sfenks: Sfenks belgelerinde tüm sınıfları, yöntemleri ve işlevleri otomatik olarak nasıl eklenir?

Ben sfenks kullanarak birkaç bin sınıfları içeren bir proje için bir html belgeleri oluşturmak için deneyin ve AutoDoc eklenti bulunmaktadır. sphinx-apidoc harika rst dosyaları oluşturur, ancak otomatik olarak autoclasses ve automethods otomasyonları yaratır.

Belgedeki tüm değişkenleri, işlevleri, sınıfları ve dekoratörleri otomatik olarak dahil etmek için sfenks içinde bir yol/komut/yardımcı program var mı?

bir ilk dosya bazıları örnek kod:

tagger Package 
================= 

:mod:`tagger` Package 
------------------------ 
.. automodule:: project.tagger 
    :members: 


:mod:`client` Module 
-------------------- 
.. automodule:: project.analyzers.tagger.client 
    :members: 
+0

['autodoc' uzantısını] kontrol ettiniz mi (http://sphinx-doc.org/ext/autodoc.html#module-sphinx.ext.autodoc)? –

+0

AutoDoc uzantısı conf.py ilave edilir: uzantıları = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode'] Sphinx bütün modülleri tespit ama sınıfları ve yöntemleri listelenmez. – Jon

+0

Yukarıdaki autodoc uzantısına göre 'undols üyelerine bayrak seçeneği vermedikçe docstrings olmayan üyeler bırakılacak' – intotecho

cevap

1

bu size yardımcı olacak sfenks uzantısı yok.

Uzatma autodoc'dur. Sonra sınıf eklemek istiyorsanız

Eğer yöntem için

.. autoclass:: <ClassName> 

Slly yazmak zorunda.

+7

Autodoc kullanıyorum. Bu demek oluyor ki .. bin saatten fazla not almam ya da bir senaryo oluşturmam gerekiyor. Otomatik algılama yok mu? – Jon

+2

'automodule 'öğesini kullanabilirsiniz. Eğer üyeleri otomatik olarak belgelemek istiyorsanız, bir üye seçeneği vardır. Lütfen bağlantıyı kontrol edin. Autodoc uzantısında çok seçenek var. – Nilesh

İlgili konular