sphinxcontrib-coffee

sphinxcontrib-кафе е разширение сфинкс, който добавя домейн CoffeeScript с autodoc подкрепа на Сфинкса.
Това се основава на coffeedoc_ да извлечете коментари източник от '' .coffee`` файлове. За да инсталирате coffeedoc глобално ::
& Nbsp; NPM инсталирате -G coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
<Силен> Usage
Първо трябва да добавите разширението към своя списък с разширения в conf.py:
& Nbsp; разширенията = ['sphinx.ext.autodoc "," sphinxcontrib.coffeedomain "]
Тъй като Python има никаква представа за това къде си източници са, трябва да го кажа къде да търсите във вашия conf.py така:
& Nbsp; coffee_src_dir = os.path.abspath ("../")
И накрая, ако вашият проект е преди всичко CoffeeScript, може да искате да се определи основния домейн, както и:
& Nbsp; primary_domain = "кафе"
<Силни> директиви и роли
Този домейн осигурява директиви модул, функционални, класа и начин, както и мет, класа, и функционални роли за съотнасяне. За да позоваване друг обект, използвайте това е напълно квалифицирано име: Името на модул, двойно дебелото черво, както и на точка отделна пътя към обекта в рамките на модула.
Например, за указване на `` swizzle`` функцията във файла `` либералните / widgets.coffee``, напишете ``: кафе: функции: `либералните / джаджи :: swizzle``. Можете да се откажа от водещите ``: coffee`` ако основният ви домейн е настроен на кафе, и ще можете да пуснете името на модула МФФ препращате от рамките на `` либералните / widgets`` модула.
<Силен> Autodoc
Можете да документира цялата модули лесно с `` automodule``:
.. :: Изходния код RST
& Nbsp; .. :: Automodule mymodule
& Nbsp; & Nbsp; & Nbsp; : Членове:

<силни> Изисквания :

• Python