sphinxcontontrib-cafe Extensión de la esfinge para agregar el soporte de Coffeescript
Descargar ahora

sphinxcontontrib-cafe Clasificación y resumen

sphinxcontontrib-cafe Etiquetas

extensión Esfinge Extensión de la esfinge Coffeescript

sphinxcontontrib-cafe Descripción

SphinxContrib-Coffee es una extensión de esfinge que agrega un dominio de Coffeescript con soporte automático a Sphinx. Esto se basa en Coffeedoc_ para extraer los comentarios de la fuente de los archivos `` .coffee``. Para instalar Coffeedoc globalmente :: NPM Instalar -G Coffeedoc .. _coffeedoc: https://github.com/omarkhan/coffeedocusagefirst Debe agregar la extensión a su lista de extensiones en Conf.py: Extensions = Debido a que Python no tiene ni idea de dónde se encuentren sus fuentes, debe decirle dónde buscar en su conf.py así: cafe_src_dir = os.path.abspath ('/') finalmente, Si su proyecto es principalmente el coffeescript, es posible que desee definir el dominio principal: primary_domain = 'Coffee'directives y Rolesthis Dominio proporciona directivas de módulo, función, clase y método, así como roles de metanfetamina, clase y func para la cruz. Referencia. Para hacer referencia a otro objeto, use su nombre completamente calificado: el nombre del módulo, un doble colon y la ruta separada del punto al objeto dentro del módulo. Por ejemplo, para hacer referencia a la función `` Swizzle`` en el archivo ` `lib / widgets.coffee``, escriba` `: Coffee: Func:` lib / widgets :: Swizzle``. Puede dejar caer el "Café" principal ". Si su dominio principal se ha configurado en Coffee, y puede eliminar el nombre del módulo IFF que está vinculando desde el módulo '` lib / widgets`` puede documentar los módulos completos fácilmente Con `` Automodule``: .. SourceCode :: RST. AUTOMOTULO :: MyModule: Miembros: Página de inicio del producto

sphinxcontontrib-cafe Software relacionado