Okydoky. Construtor de docs automatizado usando Sphinx / Github / Distribute para uso privado
Baixe Agora

Okydoky. Classificação e resumo

Okydoky. Tag

Pitão construtor Documentos construtor de documentos documentação Sphinx

Okydoky. Descrição

Okydoky é um construtor de documentação automatizado usando esfinge, distribuição e github (que foi setuptools). Faz seu projeto de Python fechado para construir continuamente documentos, com as seguintes suposições: 1. A documentação é feita usando o SphinX.2. O projeto é embalado através de setuptools (não pip nem outros) .3. O código-fonte é gerenciado no GitHub.Para dizer em breve, é simplesmente um readthedocs.org para uso privado. Como funciona as seguintes instruções nas seguintes instruções: 1. Quando novas commits são empurradas, o Github desencadeia OKYDOKY Post-Receber Hook.2. Okydoky Downloads Tarball Archives de commits empurrados de GitHub.3. Arquivo de tarball é extraído em um diretório temporário.4. Esfinge constrói a documentação.5. Quando os usuários solicitam os documentos usando seu navegador da Web, o Okydoky pede ao usuário autenticar usando o Github OAuth.6. Se eles tiverem a autorização, Okydoky serve um documento construído. Como usar o pacote de python comum. Você pode instalá-lo usando Easy_Install: Easy_Install Okydokythis Package fornece um script de linha de comando chamado OKYDOKY. É um aplicativo da Web e também um pequeno servidor da Web para si. É preciso um arquivo de configuração .Config arquivos precisam conter alguns valores necessários como a chave do aplicativo GitHub e a chave secreta. Você tem que criar um aplicativo do GitHub para usar o OKYDOKY. Seu URL de retorno de chamada é muito importante. Preencha-o com: http: // / auth / finalizeand substitui com o nome do domínio que você usará. E, em seguida, adicione um gancho pós-recebimento no seu repositório Github: http: // / Se você fizer um arquivo de configuração, execute um servidor OKYDOKY usando o Script Okydoky: Okydoky -h 0.0.0.0 -p 8080 yourconfig.pilastly , você tem que fazer uma autenticação inicial para terminar a instalação. Abra http: // / no seu navegador da Web e faça o login com o GitHub a partir daí.configurationO arquivo de config é um script Python normal. Ele usa o sistema de configuração do frasco. Leia os docs do Flask sobre Config Files.Repository O usuário e o nome do repositório e. 'Crosspop / Okydoky'.client_id a tecla do cliente do aplicativo GitHub.Client_Secret A chave secreta do aplicativo do GitHub.Save_Directory O caminho do diretório para armazenar dados. Esse diretório armazenará alguns dados configurados, tarballs e documentações construídas.secret_key a chave secreta para assinar as sessões. Veja os documentos da Flask sobre sessões também. O SourceOkydoky é escrito por Hong Minhee para Crosspop. É distribuído em licença do MIT, e o código-fonte pode ser encontrado no repositório do Github. Check-out: git clone git: //github.com/crosspop/okydoky.gitproduct's homepage

Okydoky. Software Relacionado