Okydoky. Generatore Documenti automatizzati con SPHINX / GitHub / Distribuisci per uso privato
Scarica ora

Okydoky. Classifica e riepilogo

Okydoky. Tag

Pitone costruttore documenti costruttore di documenti Documentazione Sphinx.

Okydoky. Descrizione

Okydoky è un costruttore di documentazione automatizzato con Sphinx, distribuisci e GitHub (che erano setuptools). Rende il tuo progetto Python chiuso per costruire continuamente documentazioni, con le seguenti ipotesi: 1. La documentazione viene eseguita usando SPHINX.2. Il progetto è confezionato attraverso setuptools (non pip né altri) .3. Il codice sorgente è gestito con GitHub.Per dire a breve, è semplicemente un readthedocs.org per uso privato.Come IT WorksIt funziona nelle seguenti istruzioni: 1. Quando vengono spinti nuovi commit, GitHub attiva il gancio post-ricevimento Okydoky.2. Okydoky download di archivi di tarball di impegni spinti da GitHub.3. L'archivio del tarball viene estratto in una directory temporanea.4. Sphinx costruisce la documentazione.5. Quando gli utenti richiedono documenti utilizzando il loro browser Web, Okydoky chiede all'utente di autenticare l'utilizzo di GitHub Oauth.6. Se hanno l'autorizzazione, Okydoky serve un documento costruito. Come utilizzare un normale pacchetto Python. È possibile installarlo utilizzando Easy_Install: Easy_Install Okydokythis Package fornisce uno script riga di comando chiamato Okydoky. È un'applicazione Web e anche un piccolo server Web da solo. Prende un file di configurazione. I file di configurazione devono contenere alcuni valori richiesti come il tasto di applicazione GitHub e la chiave segreta. Devi creare un'applicazione GitHub per utilizzare Okydoky. Il suo URL di callback è molto importante. Compila con: http: // / auth / finalizedand sostituisce con il nome del dominio ciò che utilizzerai. Quindi, aggiungi un gancio post-ricezione nel tuo repository GitHub: http: // / Se si effettua un file di configurazione, eseguire un server di configurazione, eseguire un server Okydoky utilizzando Okydoky Script: Okydoky -h 0.0.0.0 -p 8080 yourconfig.pilastly , devi effettuare un aggiornamento iniziale per finire l'installazione. Apri http: // / nel tuo browser Web e accedi con GitHub da lì.ConfigurationIl file di configurazione è un normale script Python. Utilizza il sistema di configurazione del flacone. Leggi i documenti di Flask Informazioni sui file di configurazione. Repository Il nome utente e repository E.G. 'CrossPop / Okydoky'.client_id Il key client di GitHub Application.Client_Secret La chiave segreta dell'applicazione GitHub.Save_Directory il percorso della directory per memorizzare i dati. Questa directory memorizzerà alcuni dati, tarball configurati e documentazioni costruite.Secret_key la chiave segreta per firmare sessioni. Guarda i documenti di Flacone delle sessioni anche.Open Souryokydoky è scritto da Hong Minhee per Crosspop. È distribuito sotto licenza MIT e il codice sorgente può essere trovato nel repository GitHub. Check out: git clone git: //github.com/crosspop/okydoky.gitproduct 'homepage

Okydoky. Software correlato