esfinge-me es una herramienta de Python que creará una cáscara documentación Esfinge para su proyecto e incluir el archivo README como el índice de la documentación de & nbsp;. Se ocupa de la extracción de los metadatos necesarios, como el nombre del proyecto, el autor y la versión de su proyecto para el uso en sus documentos Esfinge.
Una vez que utilice esfinge que construya sus documentos Esfinge, a continuación, puede añadir su proyecto al sitio: Leer El Docs y tienen README de su proyecto acogió con un atractivo documentación tema Esfinge.
Nota: El archivo README debe estar en un formato compatible reStructuredText.
Instalación
La forma más fácil de instalar esfinge-me es directamente desde PyPI usando pip o setuptools ejecutando el comando correspondiente a continuación:
PIP instalar -U esfinge-me
o:
easy_install -U esfinge-me
De lo contrario se puede descargar esfinge-me e instalarlo directamente de la fuente:
python setup.py install
Ejecutar
esfinge-me se instalará como una secuencia de comandos en todo el sistema que se puede ejecutar desde la línea de comandos, mientras que en el directorio raíz de su proyecto:
esfinge-me
Cuando se ejecuta en el directorio de su proyecto, se creará un directorio docs con dos archivos, el módulo conf.py Esfinge, y un archivo index.rst que incluirá README de su proyecto.
El módulo conf.py llama a una función de configuración de la esfinge-me que establece los mínimos ajustes necesarios para sus documentos Esfinge.
- Proyecto - se utiliza el nombre del directorio de su proyecto.
- Versión - recuperada de la versión arg de su script setup.py, o atributo __version__ de su paquete.
- Los derechos de autor - recuperada de autor arg de su script setup.py, o atributo __author__ de su paquete
Requisitos
- . Python
Comentarios que no se encuentran