esfingecontrib-coffee. Extensão Sphinx para adicionar suporte a Coffescript
Baixe Agora

esfingecontrib-coffee. Classificação e resumo

esfingecontrib-coffee. Tag

extensão Esfinge Extensão esfinge. Coffeescript.

esfingecontrib-coffee. Descrição

SphInxContrib-Coffee é uma extensão esfinge que adiciona um domínio de Coffescript com suporte a AutoDoc para Sphinx.Esta depende do CoffeDoc_ para extrair comentários de origem dos arquivos `` .coffee``. Para instalar o CoffeeDoc globalmente :: NPM Install -g CoffeeDoc .. _Coffeedoc: https://github.com/omarkhan/coffeedocusagefirst Você deve adicionar a extensão à sua lista de extensões em conf.py: extensões = Porque Python não tem idéia sobre onde suas fontes são, você deve dizer onde procurar em seu conf.py assim: coffee_src_dir = os.path.abshath (' ../ ') finalmente Se o seu projeto é primariamente coffeeescript, você pode querer definir o domínio principal também: primário_domain = 'Coffee'Directives e domínio Rolesthis fornece diretivas de módulo, função, classe e método, além de funções de meth, classe e func referenciamento. Para referenciar outro objeto, use o nome totalmente qualificado: o nome do módulo, um cólon duplo e o caminho separado do ponto para o objeto dentro do módulo.Por exemplo, para referenciar a função `` swizzle`` no arquivo ` `lib / widgets.coffee`, escrever` `: café: func:` lib / widgets :: swizzle``. Você pode deixar cair o principal ``: café` se o seu domínio primário tiver sido definido para o café, e você pode soltar o nome do módulo se você estiver vinculando de dentro do módulo `` lib / widgets``.Autodocyou pode documentar módulos inteiros com `` Automodule``` Sourcecode :: RST .. Automodule :: MyModule: Membros: Homepage do produto

esfingecontrib-coffee. Software Relacionado