sphinxcontrib-coffee

sphinxcontrib-café est une extension Sphinx qui ajoute un domaine CoffeeScript avec le soutien de autodoc Sphinx.
Cela repose sur coffeedoc_ pour extraire commentaires source de `` fichiers .coffee``. Pour installer coffeedoc globalement ::
& Nbsp; npm installer coffeedoc -g
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Utilisation
D'abord, vous devez ajouter l'extension à votre liste d'extensions dans conf.py:
& Nbsp; extensions = ['sphinx.ext.autodoc »,« sphinxcontrib.coffeedomain']
Parce que Python n'a aucune idée de l'endroit où vos sources sont, vous devez lui dire où regarder dans votre conf.py comme ceci:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Enfin, si votre projet est principalement CoffeeScript, vous voudrez peut-être de définir le domaine principal ainsi:
& Nbsp; primary_domain = «café»
Directives et Rôles
Ce domaine fournit modules, fonctions, classes et de méthodes directives, ainsi que la méthamphétamine, de classe, et les rôles FUNC renvois. Pour référencer un autre objet, utiliser son nom entièrement qualifié: Le nom du module, un double deux points, et le point chemin séparé à l'objet dans le module.
Par exemple, pour faire référence à la fonction `swizzle`` dans le fichier` `lib / widgets.coffee``, écrire` `: café: func:` lib / widgets :: swizzle``. Vous pouvez déposer le premier ``: coffee`` si votre domaine principal a été mis au café, et vous pouvez déposer le nom du module ssi vous liez à l'intérieur du module `` lib / widgets``.
Autodoc
Vous pouvez documenter des modules entiers facilement avec `` automodule``:
.. :: Premier code source
& Nbsp; .. :: Automodule mymodule
& Nbsp; & nbsp; & nbsp; : Membres:

Exigences :

• Python