sphinxcontrib-coffee

sphinxcontrib-café es una extensión de la Esfinge que añade un dominio CoffeeScript con el apoyo autodoc a Esfinge.
Esto se basa en coffeedoc_ extraer comentarios de fuentes de `` archivos .coffee``. Para instalar coffeedoc globalmente ::
& Nbsp; NGP instalar coffeedoc -g
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Uso
Primero debe agregar la extensión a su lista de extensiones en conf.py:
& Nbsp; extensiones = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Debido a que Python no tiene ni idea de dónde están sus fuentes son, que debe indicarle dónde buscar en su conf.py de este modo:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Por último, si su proyecto es principalmente CoffeeScript, es posible que desee definir el dominio principal, así:
& Nbsp; primary_domain = 'café'
Directivas y Roles
Este dominio ofrece módulos, funciones, clases y métodos directivas, así como la metanfetamina, la clase, y los roles func para las referencias cruzadas. Con el fin de hacer referencia a otro objeto, utilice su nombre totalmente calificado: El nombre del módulo, dos puntos dobles, y el camino separado de puntos para el objeto dentro del módulo.
Por ejemplo, para hacer referencia a la función `` swizzle`` en el fichero `` lib / widgets.coffee``, escribir ``: café: func: `lib / widgets :: swizzle``. Usted puede dejar el líder ``: coffee`` si su dominio principal se ha establecido en el café, y puedes colocar el nombre del módulo si y sólo si está vinculando desde dentro de la `` lib / módulo widgets``.
Autodoc
Se puede documentar módulos enteros fácilmente con `` automodule``:
.. :: Código fuente primero
& Nbsp; .. :: Automodule mimodulo
& Nbsp; & nbsp; & nbsp; : Miembros:

Requisitos :

• Python