sphinxcontrib-coffee

sphinxcontrib-kopi adalah ekstensi Sphinx yang menambahkan domain CoffeeScript dengan dukungan autodoc ke Sphinx.
Hal ini bergantung pada coffeedoc_ untuk mengekstrak sumber komentar dari `` file .coffee``. Untuk menginstal coffeedoc global ::
& Nbsp; NPM menginstal coffeedoc -g
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Penggunaan
Pertama, Anda harus menambahkan ekstensi ke daftar ekstensi di conf.py:
& Nbsp; ekstensi = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Karena Python tidak memiliki petunjuk tentang di mana sumber-sumber Anda, Anda harus mengatakan itu di mana mencarinya di conf.py Anda seperti:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Akhirnya, jika proyek Anda terutama CoffeeScript, Anda mungkin ingin menentukan domain utama juga:
& Nbsp; primary_domain = 'kopi'
Directive dan Peran
Domain ini menyediakan modul, fungsi, kelas dan metode arahan, serta meth, kelas, dan peran func untuk referensi silang. Untuk referensi objek lain, gunakan nama lengkap kualifikasi: Nama modul, usus ganda, dan titik jalur terpisah untuk obyek dalam modul.
Sebagai contoh, untuk referensi `` fungsi swizzle`` dalam file `` lib / widgets.coffee``, menulis ``: kopi: func: `lib / widget :: swizzle``. Anda dapat menjatuhkan `` terkemuka: coffee`` jika domain utama Anda telah diatur untuk kopi, dan Anda dapat menjatuhkan nama modul IFF Anda terhubung dari dalam `` lib / modul widgets``.
Autodoc
Anda dapat mendokumentasikan seluruh modul dengan mudah dengan `` automodule``:
.. :: Source pertama
& Nbsp; .. :: Automodule mymodule
& Nbsp; & nbsp; & nbsp; : Anggota:

Persyaratan :

• Python