sphinxcontrib-coffee

sphinxcontrib-cafea este o extensie Sfinx care adaugă un domeniu CoffeeScript cu sprijinul AutoDoc la Sfinx.
Acest lucru se bazează pe coffeedoc_ pentru a extrage comentarii sursă de `` fișiere .coffee``. Pentru a instala coffeedoc la nivel global ::
& Nbsp; NMP instala coffeedoc ug
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Utilizare
În primul rând trebuie să adăugați extensia la lista de extensii din conf.py:
& Nbsp; extensii = ['sphinx.ext.autodoc "," sphinxcontrib.coffeedomain "]
Deoarece Python nu are nici o idee despre unde sursele tale sunt, trebuie să-l spună unde să caute în conf.py ta astfel:
& Nbsp; coffee_src_dir = os.path.abspath ('../ ")
În cele din urmă, în cazul în care proiectul dumneavoastră este în primul rând CoffeeScript, ați putea dori să definiți domeniul principal de asemenea:
& Nbsp; primary_domain = 'cafea'
Directivele și rolurile
Acest domeniu oferă directive module, funcția, clasa și metoda, precum si met, clasa, si roluri de func pentru eco-referințe. În scopul de a de referință un alt obiect, să-l utilizați este numele complet calificat: numele modulului, un colon dublu, iar calea punct separat la obiectul cadrul modulului.
De exemplu, pentru a face referire la `` funcția swizzle`` în dosarul `` lib / widgets.coffee``, scrie ``: cafea: FUNC: `lib / widget-uri :: swizzle``. Puteți renunța la conducere ``: coffee`` dacă domeniul principal a fost setat la cafea, și puteți renunța la numele modulului dacă și numai dacă vă sunt conectarea la în cadrul `` lib / modulul widgets``.
AutoDoc
Puteți documenta module întregi cu ușurință cu `` automodule``:
.. :: Sourcecode prima
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : Membrii:

Cerințe :

• Python