sphinxcontrib-kavos Sfinksas plėtinys, kuris prideda CoffeeScript domeną su autodoc paramos Sfinksas.
Tai priklauso nuo coffeedoc_ išgauti šaltinio pastabas `` .coffee`` failus. Norėdami įdiegti coffeedoc pasaulyje ::
& Nbsp; NPM įdiegti -G coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Naudojimas
Pirmiausia jūs turite pridėti plėtinį į savo sąrašą, plėtinių conf.py:
& Nbsp; plėtiniai = ['sphinx.ext.autodoc "," sphinxcontrib.coffeedomain']
Kadangi Python neturi apie tai, kur jūsų šaltiniai yra clue, turite jį ten, kur ieškoti savo conf.py kaip tiek pasakyti:
& Nbsp; coffee_src_dir = os.path.abspath ("../)
Galiausiai, jei jūsų projektas pirmiausia CoffeeScript, jūs galbūt norėsite nustatyti pagrindinį domeną, taip pat:
& Nbsp; primary_domain = 'kavos'
direktyvas ir vaidmenys "
Šioje srityje suteikia modulis, funkcijos, klasės ir metodas direktyvas, taip pat meth, klasę ir func vaidmenis dalines nuorodas. Siekiant referencinius kitą objektą, naudokite tai visiškai kvalifikuotas pavadinimas: modulis, pavadinimas, dvigubas dvitaškis ir taškas atskiras kelias per modulio objektas.
Pavyzdžiui, jei norite, kad nuoroda `` swizzle`` funkciją failą `` lib / widgets.coffee``, rašyti ``: kavos: func: `lib / raštai :: swizzle``. Jūs galite palikti lyderio ``: coffee`` jei jūsų pagrindinis domenas buvo nustatytas kavos, ir jūs galite nukristi modulio pavadinimą IFF jūs susiejimas iš per `` lib / widgets`` modulį.
autodoc
Galite dokumentuoti visą modulius lengvai su `` automodule``:
.. :: Sourcecode RST
& Nbsp; .. :: Automodule mymodule
& Nbsp; & nbsp; & nbsp; : Prisijungę:
Reikalavimai :
- Python
Komentarai nerastas