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; .. :: MyModule automodule
& NBSP; & NBSP; & NBSP; : Участники:
Требования
- Python
Комментарии не найдены