sphinxcontrib-coffee

Tela Software:
sphinxcontrib-coffee
Detalhes de Software:
Versão: 0.2.0
Data de upload: 14 Apr 15
Revelador: Stephen Sugden
Licença: Livre
Popularidade: 3

Rating: nan/5 (Total Votes: 0)

sphinxcontrib-café é uma extensão do Sphinx que adiciona um domínio CoffeeScript com apoio autodoc a Esfinge.
Isso depende da coffeedoc_ para extrair comentários de origem de `` arquivos .coffee``. Para instalar coffeedoc globalmente ::
& Nbsp; npm instalar coffeedoc -g
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Uso
Primeiro você deve adicionar a extensão de sua lista de extensões em conf.py:
& Nbsp; extensões = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Porque Python não tem nenhuma pista sobre onde suas fontes são, você deve dizer-lhe para onde olhar em sua conf.py assim:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Finalmente, se o seu projeto é principalmente CoffeeScript, você pode querer definir o domínio primário, bem como:
& Nbsp; primary_domain = 'café'
Diretrizes e Funções
Este domínio fornece módulos, funções, classes e métodos, diretrizes, bem como meth, classe e papéis func para referência cruzada. A fim de fazer referência a outro objeto, use o seu nome totalmente qualificado: O nome do módulo, dois pontos duplos, eo ponto caminho separado para o objeto dentro do módulo.
Por exemplo, para fazer referência a função `` swizzle`` no arquivo `` lib / widgets.coffee``, escrever ``: café: func: `lib / widgets :: swizzle``. Você pode deixar cair a principal ``: coffee`` se o seu domínio primário foi definido para o café, e você pode deixar cair o nome do módulo sse você está ligando de dentro do `` / módulo widgets`` lib.
AutoDoc
Você pode documentar módulos inteiros facilmente com `` automodule``:
.. :: Sourcecode primeiro
& Nbsp; .. :: Automodule mymodule
& Nbsp; & nbsp; & nbsp; : Membros:

Requisitos :

  • Python

Programas semelhantes

Comentário para sphinxcontrib-coffee

Comentários não encontrado
Adicionar comentário
Ligue imagens!