SPHINXCONTRIB-COFFE Extension SPHINX Pour ajouter un support de CoffeScript
Télécharger maintenant

SPHINXCONTRIB-COFFE Classement & Résumé

SPHINXCONTRIB-COFFE Mots clés

extension Sphinx Extension Sphinx Cafetière

SPHINXCONTRIB-COFFE La description

SphinxContrib-Coffee est une extension Sphinx qui ajoute un domaine CoffeScript avec la prise en charge de Autodoc à Sphinx.Ce compte sur Coffeedoc_ pour extraire des commentaires de la source de fichiers `` .coffee``. Pour installer Coffeedoc global :: NPM Installer -g -g-goffeedoc .. _cuoffeedoc: https://github.com/omarkhan/coffeedocusageFirst Vous devez ajouter l'extension à votre liste des extensions dans Conf.py: Extensions = Parce que Python n'a aucune idée de l'endroit où vos sources sont, vous devez le dire où regarder dans votre Conf.py comme: Coffee_src_dir = OS.Path.Abspath (' ../ ') Enfin, Si votre projet est principalement du café, vous voudrez peut-être définir également le domaine principal: le domaine primaire_Domain = 'Directives de Coffee'Directives et Rolesthis fournit des directives de module, de fonctionnement, de classe et de méthode, ainsi que des rôles de méthod. référencement. Afin de référencer un autre objet, utilisez son nom entièrement qualifié: le nom du module, un double côlon et le chemin séparé du point sur l'objet dans le module.Pro exemple, pour référencer la fonction `` Swizzle`` dans le fichier ` `lib / widgets.coffee``, écrire` `: café: func:` lib / widgets :: swizzle``. Vous pouvez laisser tomber le premier ``: Coffee`` Si votre domaine principal a été réglé sur Coffee, vous pouvez supprimer le nom du module IFF que vous liez dans le module `` lib / widgets```AutodoCYou peut documenter facilement les modules entiers. Avec `` automodule``: .. SourceCode :: RST. Automodule :: MyModule: Membres: Page d'accueil du produit

SPHINXCONTRIB-COFFE Logiciels associés