Okydoky

Okydoky est un constructeur de documentation automatisée utilisant Sphinx, distribuer et GitHub (qui était setuptools) & nbsp; Il rend votre projet Python fermé à construire en permanence documentations, avec les hypothèses suivantes.:
1. La documentation est fait en utilisant Sphinx.
2. Projet est emballé par setuptools (non pip ni les autres).
3. Le code source est géré sous GitHub.
Pour dire peu de temps, ce est simplement une ReadTheDocs.org pour un usage privé.
Comment ça marche?
Il fonctionne dans les instructions suivantes:
1. Lorsque de nouveaux commits sont poussés, GitHub déclenche Okydoky post-recevoir crochet.
2. téléchargements Okydoky archive archives de commits poussés de GitHub.
3. archive Tarball se extrait dans un répertoire temporaire.
4. Sphinx construit la documentation.
5. Lorsque les utilisateurs demandent les documents en utilisant leur navigateur Web, Okydoky demande à l'utilisateur de se authentifier via GitHub OAuth.
6. Se ils a l'autorisation, Okydoky sert un docs construits.
Comment utiliser
Ce est un paquet de Python ordinaire. Vous pouvez l'installer en utilisant easy_install:
& Nbsp; easy_install Okydoky
Ce paquet fournit un script de ligne de commande appelé okydoky. Ce est une application web et aussi un petit serveur web pour lui-même. Il faut un fichier de configuration.
Les fichiers de configuration doivent contenir des valeurs requises comme GitHub clé d'application et la clé secrète.
Vous devez créer une application à utiliser Okydoky GitHub. Son rappel URL est très important. Remplissez-le avec:
http: // / auth / finalisation
et remplace par le nom de domaine que vous allez utiliser. Et puis, ajouter un post-recevoir crochet dans votre référentiel GitHub:
http: // /
Si vous faites un fichier de configuration, puis exécutez un serveur en utilisant un script Okydoky okydoky:
& Nbsp; -H okydoky 0.0.0.0 -p 8080 yourconfig.py
Enfin, vous devez faire une auth initiale pour terminer l'installation. Ouvrez http: // / dans votre navigateur Web et se connecter avec GitHub à partir de là.
Configuration
Le fichier de configuration est un script Python normale. Il utilise le système de configuration de flacon. Lisez les docs de Flask sur les fichiers de configuration.
GARDE
& Nbsp; Le nom d'utilisateur et un référentiel par exemple 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; la clé du client de l'application GitHub.
CLIENT_SECRET
& Nbsp; clé secrète de l'application GitHub.
SAVE_DIRECTORY
& Nbsp; Le chemin du répertoire pour stocker les données. Ce répertoire sera stocker des données, archives tar, et documentations construits configurés.
Secret_key
& Nbsp; La clé secrète pour signer sessions. Voir les docs de ballon environ séances aident aussi.
Open source
Okydoky est écrit par Hong Minhee pour Crosspop. Il est distribué sous licence MIT, et le code source peut être trouvé dans le référentiel GitHub. Check-out:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Quoi de neuf dans cette version:

• GitHub forcé Etat pour OAuth. Suivez ce.

Quoi de neuf dans la version 0.9.4:

• Utilisez l'option --upgrade pour développer setup.py commande. Cela empêche les conflits de version de dépendances.
• Construire journaux sont laissés dans le fichier build.txt.

Quoi de neuf dans la version 0.9.3:

• Maintenant la page d'index montre la liste des arbitres.
• Maintenant ensembles Okydoky OKYDOKY = 1 variable de l'environnement au cours de son processus de construction. [# 5]
• Ajout / tête spéciale ref url.
• Correction d'un bug que la tête ne est pas réglé sur la dernière commis.

Ce qui est nouveau dans la version 0.9.2:

• Correction d'un bug de sécurité: désormais les utilisateurs doivent avoir un l'autorisation pour le référentiel. [# 4]

Exigences :

• Python