Okydoky

Okydoky é um construtor de documentação automatizada usando Sphinx, distribuir e GitHub (que foi setuptools) & nbsp; Não faz o seu projeto Python fechado para construir continuamente documentações, com as seguintes premissas.:
1. A documentação é feito usando Esfinge.
2. Projeto é embalado através setuptools (não pip nem quaisquer outros).
3. O código fonte é gerido sob GitHub.
Para dizer pouco, é simplesmente um ReadTheDocs.org para uso privado.
Como funciona
Ele funciona nos seguintes instruções:
1. Quando novos commits são empurrados, GitHub desencadeia Okydoky pós-receber gancho.
2. Importar Okydoky arquivo tar arquivos do commits empurrado do GitHub.
3. arquivo Tarball fica extraído em um diretório temporário.
4. Sphinx constrói a documentação.
5. Quando o usuário solicita os documentos usando seu navegador, Okydoky pede ao usuário para autenticar usando GitHub OAuth.
6. Se eles tem a autorização, Okydoky serve um docs construídos.
Como usar
É um pacote Python comum. Você pode instalá-lo usando easy_install:
& Nbsp; easy_install Okydoky
Este pacote fornece um script de linha de comando chamado okydoky. É uma aplicação web e também um pequeno servidor web por si. É preciso um arquivo de configuração.
Arquivos de configuração tem que conter alguns valores necessários, como chave de aplicação GitHub e chave secreta.
Você tem que criar um aplicativo para usar Okydoky GitHub. Sua Callback URL é muito importante. Encha-o com:
http: // / auth / finalize
e substitui com o nome de domínio que você vai usar. E, em seguida, adicione um gancho de pós-receber em seu repositório GitHub:
http: // /
Se você fizer um arquivo de configuração, em seguida, executar um servidor usando o script Okydoky okydoky:
& Nbsp; -H okydoky 0.0.0.0 -p 8080 yourconfig.py
Por último, você tem que fazer um auth inicial para concluir a instalação. Abra http: // / no seu navegador e faça login com GitHub de lá.
Configuração
O arquivo de configuração é um script Python normal. Ele usa sistema de configuração do Flask. Leia docs do balão cerca de arquivos de configuração.
REPOSITORY
& Nbsp; O nome de usuário e repositório de exemplo 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; chave de cliente do aplicativo GitHub.
CLIENT_SECRET
& Nbsp; a chave secreta do aplicativo GitHub.
SAVE_DIRECTORY
& Nbsp; O caminho do diretório para armazenar dados. Esse diretório irá armazenar alguns dados, tarballs, e documentações construídas configurados.
SECRET_KEY
& Nbsp; A chave secreta para assinar sessões. Veja a documentação do balão cerca de sessões também.
Open source
Okydoky é escrito por Hong Minhee para Crosspop. É distribuído sob a licença MIT, e o código-fonte pode ser encontrado no repositório GitHub. Confira:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

O que é novo nesta versão:

• GitHub estado forçado para OAuth. Siga isso.

O que é novo na versão 0.9.4:

• Use a opção --upgrade para setup.py desenvolver comando. Isso evita conflitos de versão de dependências.
• Criar registros são deixados no arquivo build.txt.

O que é novo na versão 0.9.3:

• Agora a página do índice mostra a lista de refs.
• Agora sets Okydoky OKYDOKY = variável um ambiente durante o processo de criação. [# 5]
• Adicionar / cabeça especial url ref.
• Corrigido um bug que a cabeça não está definido para o último commit.

O que é novo na versão 0.9.2:

• Corrigido um bug de segurança: agora os usuários devem ter uma autorização para o repositório. [# 4]

Requisitos :

• Python