sphinxcontrib-coffee

sphinxcontrib-kahvi on sfinksi laajennus, joka lisää CoffeeScript verkkotunnus AutoDoc tukea Sphinx.
Tämä perustuu coffeedoc_ poimia lähde kommentit `` .coffee`` tiedostoja. Voit asentaa coffeedoc maailmanlaajuisesti ::
& Nbsp; NPM asentaa -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Käyttö
Ensin sinun on lisättävä laajennus luetteloon laajennuksia conf.py:
& Nbsp; laajennukset = ['sphinx.ext.autodoc "," sphinxcontrib.coffeedomain']
Koska Python ei ole aavistustakaan siitä, missä lähteet ovat, sinun täytyy kertoa se, mistä etsiä oman conf.py kuten niin:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Lopuksi, jos hanke on ensisijaisesti CoffeeScript, saatat haluta määritellä ensisijainen verkkotunnus samoin:
& Nbsp; primary_domain = "kahvi"
Direktiivit ja roolit
Tämä verkkotunnus tarjoaa moduuli, toiminto, luokka ja menetelmä direktiivejä sekä met, luokka, ja toi roolit vertailemalla. Jotta viitata toiseen kohteeseen, käytä se täysin pätevä nimi: moduulin nimi, kaksinkertainen kaksoispiste, ja piste erillinen polku esineen moduuli.
Esimerkiksi viittaus `` swizzle`` toiminto tiedoston `` lib / widgets.coffee``, kirjoittaa ``: kahvi: FUNC: `lib / widgetit :: swizzle``. Voit pudottaa johtava ``: coffee`` jos ensisijainen verkkotunnus on asetettu kahvia, ja voit pudottaa moduulin nimi joss haluat linkittää sisällä `` lib / widgets`` moduuli.
AutoDoc
Voit dokumentoida koko moduulit helposti `` automodule``:
.. Lähdekoodin :: RST
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : Jäsenet:

Vaatimukset :

• Python