sphinxcontrib-coffee

sphinxcontrib-kawa jest rozszerzenie Sfinks, który dodaje się do domeny CoffeeScript z obsługą autodoktora do Sfinksa.
To zależy od coffeedoc_ wyodrębnić komentarze źródłowe z `` .coffee`` plików. Aby zainstalować coffeedoc globalnie ::
& Nbsp; npm zainstalować -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Zastosowanie
Najpierw należy dodać rozszerzenie do listy rozszerzeń w conf.py:
& Nbsp; Rozszerzenia = ['sphinx.ext.autodoc "," sphinxcontrib.coffeedomain']
Ponieważ Python nie ma pojęcia o tym, gdzie swoje źródła są, trzeba powiedzieć to, gdzie szukać w conf.py tak:
& Nbsp; coffee_src_dir = os.path.abspath ("../")
Wreszcie, jeśli projekt jest przede wszystkim CoffeeScript, możesz zdefiniować domeny podstawowej, a także:
& Nbsp; primary_domain = "kawy"
Dyrektywy i Role
Ta domena zawiera modułów, funkcji, klas i metod dyrektyw, jak również met, klasy i FUNC role odsyłaniu. Aby odwoływać inny obiekt, należy to w pełni kwalifikowana nazwa: nazwa modułu, Podwójny dwukropek, i kropka oddzielna ścieżka do obiektu w module.
Na przykład, aby odwołać się do funkcji swizzle`` `` w pliku `` lib / widgets.coffee``, napisać ``: kawa: func: `lib / widżety :: swizzle``. Możesz spadek wiodącą ``: coffee`` jeśli głównym domeny została ustawiona na kawę, a można upuścić nazwę modułu wtedy i tylko wtedy łączysz z wewnątrz `` lib / module widgets``.
autodoktora
Możesz łatwo udokumentować cały moduł z `` automodule``:
.. Sourcecode :: RST
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : Skład:

Wymagania :

• Python