sphinxcontrib-coffee

sphinxcontrib-qəhvə Sphinx üçün autodoc dəstəyi ilə CoffeeScript domen əlavə bir Sphinx uzantısıdır.
Bu `` .coffee`` faylları mənbə şərh çıxarış coffeedoc_ əsaslanır. Qlobal coffeedoc yüklemek üçün ::
& Nbsp; MPM-g coffeedoc bərpa
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
istifadə
Birinci siz conf.py olan uzantıları listenize uzadılması əlavə etməlidir:
& Nbsp; uzantıları = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Python Sizin mənbələri olduğu haqqında heç bir ipucu var, çünki, siz belə kimi conf.py baxmaq üçün demək lazımdır:
& Nbsp; coffee_src_dir = os.path.abspath (../)
Sizin layihə ilk növbədə CoffeeScript əgər Nəhayət, siz də əsas domen müəyyən edə bilərsiniz:
& Nbsp; primary_domain = 'qəhvə'
Direktiv və rolu
Bu domain cross-sened üçün modul, funksiyası, sinif və üsul direktivləri, eləcə də Meth, sinif və func rolları təmin edir. Modul adı, ikiqat kolon, və modul çərçivəsində obyekt üçün dot ayrı-ayrı yol: bir obyekt istinad üçün, tam ixtisaslı adı istifadə edin.
Qəhvə: func: `lib / widgets :: swizzle`` Məsələn, fayl` `lib / widgets.coffee``,` `yazmaq da` `swizzle`` funksiyası istinad. Sizin əsas domen qəhvə müəyyən edilmişdir coffee`` və `` lib / widgets`` modul ərzində birləşdirən olunur iff modul adı açılır: Siz aparıcı `` açılır.
Autodoc
Siz asanlıqla `` automodule`` ilə bütün modulları sənəd bilər:
.. Sourcecode :: birinci
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : Üzvləri:

tələblər

• Python