sphinxcontrib-coffee

sphinxcontrib-kape ay isang Sphinx extension na nagdaragdag ng isang CoffeeScript domain na may autodoc suporta sa Sphinx.
Ito ay umaasa sa coffeedoc_ i-extract ang source na komento mula sa `` .coffee`` mga file. Upang i-install coffeedoc sa buong mundo ::
& Nbsp; npm-install -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Paggamit
Unang dapat mong idagdag ang extension sa iyong listahan ng mga extension sa conf.py:
& Nbsp; = extension ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Dahil Python ay walang bakas tungkol sa kung saan ang iyong mga mapagkukunan ay, dapat mong sabihin dito kung saan upang tumingin sa iyong conf.py tulad nito:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Sa wakas, kung ang iyong proyekto ay pangunahing CoffeeScript, baka gusto mong matukoy ang pangunahing domain pati na rin ang:
& Nbsp; primary_domain = 'coffee'
Direktiba at Tungkulin
Ang domain na ito ay nagbibigay ng module, function, uri at pamamaraan ng kautusan, pati na rin ang meth, klase, at func mga tungkulin para sa cross-tumutukoy. Upang isangguni ibang bagay, gamitin ito ay ganap na kwalipikadong pangalan: Ang pangalan ng module, double tutuldok, at ang tuldok na hiwalay na daanan sa object sa loob ng module.
Halimbawa, upang isangguni ang `` swizzle`` pag-andar sa file `` Lib / widgets.coffee``, isulat ``: coffee: func: `Lib / widget :: swizzle``. Maaari mong i-drop ang nangungunang ``: coffee`` kung ang iyong pangunahing domain ay naitakda sa kape, at maaari mong ilagay ang pangalan ng module iff mo ay nagli-link mula sa loob ng `` Lib / widgets`` module.
Autodoc
Maaari mong idokumento ang buong module madali gamit `` automodule``:
.. Sourcecode :: rst
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : Kasapi:

Mga Kinakailangan :

• Python