Okydoky Constructeur Documents automatisé à l'aide de Sphinx / GitHUB / Distributeur pour une utilisation privée
Télécharger maintenant

Okydoky Classement & Résumé

Okydoky Mots clés

Python constructeur documents générateur de documents Documentation SPHINX

Okydoky La description

Okydoky est une documentation automatisée en utilisant Sphinx constructeur, la distribution et GitHub (qui était setuptools). Il rend votre projet Python fermé à construire en permanence documentations, avec les hypothèses suivantes: 1. La documentation est effectuée à l'aide Sphinx.2. Le projet est emballé par setuptools (non pip, ni tout autre) .3. Le code source est géré sous GitHub.To dire peu de temps, il est tout simplement un ReadTheDocs.org pour un usage privé use.How il worksIt travaux dans les instructions suivantes: 1. Lorsque de nouveaux commits sont poussés, GitHub déclenche après réception Okydoky hook.2. Okydoky téléchargements TARBALL archives de commits Chassés des GitHub.3. archives tarball s'extrait dans un directory.4 temporaire. Sphinx construit le documentation.5. Lorsque les utilisateurs demandent la documentation à l'aide de leur navigateur Web, Okydoky demande à l'utilisateur d'authentifier à l'aide GitHub OAuth.6. Si elles a l'autorisation, Okydoky sert un docs.How construit un paquet Python ordinaire useIt. Vous pouvez l'installer à l'aide easy_install: easy_install package OkydokyThis fournit un script de ligne de commande appelé okydoky. Il est une application web et aussi un petit serveur web pour lui-même. Il faut un fichier de configuration des fichiers .config doivent contenir des valeurs requises comme la clé de l'application GitHub et key.You secrets doivent créer une application GitHub utiliser Okydoky. Son URL est Callback très important. Remplissez-le avec: http: // / auth / finalizeand remplace avec le nom de domaine que vous allez utiliser. Et puis, ajoutez un crochet après réception dans votre dépôt GitHub: http: // / Si vous faites un fichier de configuration, puis exécutez un serveur Okydoky en utilisant un script okydoky: okydoky -H 0.0.0.0 -p 8080 yourconfig.pyLastly , vous devez faire une auth initiale à l'installation d'arrivée. Ouvrez http: // / dans votre navigateur Web et connectez-vous avec GitHub de there.ConfigurationThe fichier de configuration est un script Python normal. Il utilise le système de configuration de Flask. docs de lecture Flask sur config files.REPOSITORY L'utilisateur et le nom du référentiel par exemple « Crosspop / okydoky'.CLIENT_ID Le client de l'application GitHub key.CLIENT_SECRET Le key.SAVE_DIRECTORY secret de l'application GitHub Le chemin du répertoire pour stocker des données. Ce répertoire stocke certaines données configurées, tarballs, et construit documentations.SECRET_KEY La clé secrète pour signer des sessions. Voir les documents de Flask sur les sessions also.Open sourceOkydoky est écrit par Hong Minhee pour Crosspop. Il est distribué sous licence MIT, et le code source peut être trouvée dans le dépôt GitHub. Départ: git clone git: //github.com/crosspop/okydoky.gitProduct's page d'accueil

Okydoky Logiciels associés