Okydoky Constructor automatizado de documentos usando Sphinx / GitHub / Distribute para uso privado
Descargar ahora

Okydoky Clasificación y resumen

Okydoky Etiquetas

Pitón constructor documentos constructor de documentos Documentación de la esfinge

Okydoky Descripción

Okydoky es un constructor de documentación automatizado que usa Esfinge, Distribute y GitHub (que fue setuptools). Hace que su proyecto de Python cerrado para construir continuamente documentaciones, con los siguientes supuestos: 1. La documentación se realiza utilizando Sphinx.2. El proyecto se envasa a través de SetuptOols (no PIP ni otros) .3. El código fuente se administra bajo GitHub.Para decir en breve, es simplemente un archivo letsthedocs.org para uso privado. Cómo funciona el trabajo de TI en las siguientes instrucciones: 1. Cuando se empujan nuevos comisiones, GitHub se dispara a Okydoky Post-Recibir Hook.2. Okydoky descarga los archivos de tarball de los comisiones empujados de GitHub.3. El archivo de tarball se extrae en un directorio temporal.4. Esfinge construye la documentación.5. Cuando los usuarios solicitan los documentos utilizando su navegador web, Okydoky le pide al usuario que se autentique utilizando GitHub Oauth.6. Si tiene la autorización, Okydoky sirve a un documento construido. Cómo usar el paquete ordinario de Python. Puede instalarlo usando Easy_Install: Easy_Install Okydokythis Package proporciona un script de línea de comandos llamado Okydoky. Es una aplicación web y también un pequeño servidor web para sí mismo. Se necesita un archivo de configuración. Los archivos .config tienen que contener algunos valores requeridos como la clave de aplicación GitHub y la clave secreta. Tienes que crear una aplicación GitHub para usar Okydoky. Su URL de devolución de llamada es muy importante. Rellenelo con: http: // / auth / finalizizeD reemplaza con el nombre de dominio lo que usará. Y luego, agregue un gancho posterior a la recepción a su repositorio de GitHub: http: // / si realiza un archivo de configuración, ejecute un servidor Okydoky usando Okydoky Script: Okydoky -H 0.0.0.0 -p 8080 yourconfig.pylly , Tienes que hacer una autenticación inicial para terminar la instalación. Abra http: // / en su navegador web e inicie sesión con GitHub desde allí.ConfigurationEl Config File es un script normal de Python. Utiliza el sistema de configuración de Flask. Lea los documentos de Flask sobre los archivos de configuración. Repositorio del nombre del usuario y el repositorio por ejemplo. 'CrossPop / Okydoky'.client_id The GitHub Application's Client Key.Client_Secrett The GitHub Secret Secret Key.save_directory La ruta del directorio para almacenar datos. Este directorio almacenará algunos datos configurados, tarballs y documentaciones construidas.secret_key la clave secreta para firmar sesiones. Vea los documentos de Flask sobre las sesiones también. Sobre SournOkydoky está escrito por Hong Minhee para CrossPop. Se distribuye en la licencia MIT, y el código fuente se puede encontrar en el repositorio de GitHub. Salida: git clone git: //github.com/crosspop/okydoky.gitproduct 'homepage

Okydoky Software relacionado