sphinxcontrib-kahve Sfenks için AutoDoc desteği ile CoffeeScript etki katan bir Sfenks uzantısıdır.
Bu `` .coffee`` dosyaları kaynak yorum ayıklamak için coffeedoc_ dayanır. Küresel coffeedoc yüklemek için ::
& Nbsp; npm -g coffeedoc yüklemek
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Kullanım
Önce conf.py uzantıları listenize uzantısı eklemek gerekir:
& Nbsp; uzantıları = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Python sizin kaynaklar nerede hakkında hiçbir ipucu var, çünkü nereye kadar gibi conf.py bakmak için bunu söylemek gerekir:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Projeniz öncelikle CoffeeScript Son olarak, eğer, siz de birincil etki tanımlamak isteyebilirsiniz:
& Nbsp; primary_domain = 'kahve'
Direktifler ve Roller
Bu etki, çapraz-referans için modül, fonksiyon, sınıf ve metot direktifleri yanı sıra meth, sınıf, ve fonksiyon roller sağlar. Modül adı, bir çift kolon, ve modül içindeki nesneye nokta ayrı yol: başka bir nesneyi referans için, tam nitelikli bir isim kullanın.
Kahve: işlev: `lib / widget :: swizzle`` Örneğin, dosyanın` `lib / widgets.coffee``,` `yazmak içinde` `swizzle`` işlevine başvurmak için. Birincil etki kahve ayarlanmış olup olmadığını coffee`` ve `` lib / widgets`` modül içinde bağlantı vardır IFF modül adı bırakabilirsiniz: Sen önde gelen `` bırakabilirsiniz.
AutoDoc
Kolayca `` automodule`` ile tüm modülleri belge olabilir:
.. :: Sourcecode ilk
& Nbsp; .. :: Automodule MyModule
& Nbsp; & nbsp; & nbsp; : Üyeler:
Gereksinimler :
- Python
Yorum Bulunamadı