Okydoky

Okydoky es un constructor de documentación automatizado utilizando Esfinge, distribuir y GitHub (que era setuptools) & nbsp; que hace que su proyecto Python cerrado para construir continuamente documentaciones, con los siguientes supuestos.:
1. La documentación se realiza mediante Esfinge.
2. Proyecto se envasa a través setuptools (no pip ni cualquier otro).
3. El código fuente se gestiona bajo GitHub.
Decir en breve, es simplemente un ReadTheDocs.org para uso privado.
¿Cómo funciona?
Funciona en las siguientes instrucciones:
1. Cuando se empujan nuevas confirmaciones, GitHub desencadena Okydoky posterior a recibir el gancho.
2. descargas Okydoky tarball archivos de commits empujados desde GitHub.
3. Archivo Tarball se extrae en un directorio temporal.
4. Esfinge construye la documentación.
5. Cuando los usuarios solicitan la documentación usando su navegador web, Okydoky pide al usuario que se autentique utilizando GitHub OAuth.
6. Si tiene la autorización, Okydoky sirve una docs construidas.
¿Cómo utilizar
Es un paquete Python ordinaria. Puede instalarlo mediante easy_install:
& Nbsp; easy_install Okydoky
Este paquete proporciona un script de línea de comandos denominada okydoky. Es una aplicación web y también un pequeño servidor web por sí mismo. Se necesita un fichero de configuración.
Los archivos de configuración tienen que contener algunos valores requeridos como clave de aplicación de GitHub y clave secreta.
Tienes que crear una aplicación de GitHub utilizar Okydoky. Su Callback URL es muy importante. Rellenar con:
http: // / auth / finalize
y reemplaza con el nombre de dominio lo que vamos a usar. Y luego, añadir un-recibir correos gancho en su repositorio GitHub:
http: // /
Si comete un archivo de configuración, a continuación, ejecutar un servidor Okydoky usar la escritura okydoky:
& Nbsp; -H okydoky 0.0.0.0 -p 8080 yourconfig.py
Por último, hay que hacer una autenticación inicial para terminar la instalación. Abra http: // / en su navegador web y acceder con GitHub desde allí.
Configuración
El archivo de configuración es un script normal de Python. Se utiliza el sistema de configuración del frasco. Leer docs Frasco acerca de los archivos de configuración.
GUARDAMUEBLES
& Nbsp; El nombre de usuario y el repositorio, por ejemplo, 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; La clave de cliente de aplicación GitHub.
CLIENT_SECRET
& Nbsp; La clave secreta de aplicación GitHub.
SAVE_DIRECTORY
& Nbsp; La ruta del directorio para almacenar datos. Este directorio almacena algunos datos, archivos comprimidos, y documentaciones construidas configurados.
SECRET_KEY
& Nbsp; La clave secreta para firmar sesiones. Ver docs Frasco sobre sesiones también.
El código abierto
Okydoky está escrito por Hong Minhee para Crosspop. Se distribuye bajo licencia MIT, y el código fuente se puede encontrar en el repositorio GitHub. Echa un vistazo:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

¿Cuál es nuevo en esta versión:

• GitHub estado obligado para OAuth. Siga eso.

¿Cuál es nuevo en la versión 0.9.4:

• Utilice la opción --upgrade para desarrollar setup.py comandos. Esto evita conflictos de versión de dependencias.
• Construir logs se dejan en el archivo build.txt.

¿Cuál es nuevo en la versión 0.9.3:

• Ahora la página de índice muestra la lista de árbitros.
• Ahora conjuntos Okydoky OKYDOKY = variable de 1 ambiente durante su proceso de construcción. [# 5]
• Añadir / cabeza url especial ref.
• Se ha corregido un error por el que la cabeza no se ajusta a la última cometió.

¿Qué hay de nuevo en la versión 0.9.2:

• Se ha corregido un error de seguridad: ahora los usuarios deben tener un autorización para el repositorio. [# 4]

Requisitos :

• Python