sphinxcontrib-coffee

sphinxcontrib-кава розширення Сфінкс, який додає домен CoffeeScript з AutoDoc підтримки Сфінкса.
Це залежить від coffeedoc_, щоб витягти вихідні коментарі від `` .coffee`` файлів. Щоб встановити coffeedoc глобально ::
І NBSP; НПМ установки -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Використання
Спочатку ви повинні додати розширення в список розширень в conf.py:
І NBSP; Розширення = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Оскільки Python не має ні найменшого поняття про те, де ваші джерела, ви повинні повідомити йому, де шукати в conf.py так:
І NBSP; coffee_src_dir = os.path.abspath ('../')
Нарешті, якщо ваш проект, насамперед, CoffeeScript, ви можете визначити первинний домен, а також:
І NBSP; primary_domain = 'кави'
директиви і ролі
Цей домен надає директиви модуля, функції, класів і методів, а також метамфетамін, клас і Func ролі перехресних посилань. Для того, щоб посилатися на інший об'єкт, використовувати його повне ім'я: ім'я модуля, подвійне двокрапка, і крапка окремий шлях до об'єкта всередині модуля.
Наприклад, для посилання на `` swizzle`` функцію у файлі `` Бібліотека / widgets.coffee`` писати ``: кава: FUNC: `Бібліотека / віджети :: swizzle``. Ви можете залишити провідну ``: coffee`` якщо ваш основний домен був встановлений в каві, і ви можете відмовитися від назви модуля тоді і тільки тоді ви посилаєтеся зсередини `` LIB / widgets`` модуля.
Autodoc
Ви можете документально підтвердити модулів в цілому легко з `` automodule``:
.. Вихідний код :: спочатку
І NBSP; .. Automodule :: MyModule
І NBSP; & NBSP; & NBSP; : Учасники:

Вимоги

• Python