Tracsphinx Clasificación y resumen
- Nombre del editor:
- Florent PIGOUT
Tracsphinx Etiquetas
Tracsphinx Descripción
Plugin Sphinx para TRAC 0.11 Primer borrador para esfinge como el complemento fácil de usar. TRACSPHINX implementa tareas básicas para administrar la documentación de la esfinge en TRAC.1. Plugin InstallDown Las fuentes de complemento, descomprimen el archivo y escriba el comando Easy_InStall desde la carpeta del complemento: $ Easy_Install Setup.py installRestart The TRAC Project (s). Como administrador, ahora podemos activar el complemento. Por defecto, la carpeta de la fuente de documentación es './docs/source' del repositorio del proyecto. Pero en la mayoría de los casos anularemos esta ruta en la sección del archivo 'trac.ini' del proyecto: source_dir = / / Esta carpeta de origen es utilizada por el proyecto para construir la documentación de la esfinge utilizando el Constructor web de Esfinge. Si la documentación no se puede generar a partir de TRAC, podemos especificar la ruta de documentación generada con la siguiente opción: DOC_DIR = / También podemos configurar el título de NAVBAR con la siguiente opción: NavBAR_TITLE = MI DOCUMENTOTION2. Documentación Actualizaciones Paramonedas en la URL del proyecto Para actualizar la documentación de la carpeta de origen del proyecto a la carpeta del proyecto TRAC './sphinx-docs'. Simplemente escriba la siguiente URL para la actualización: http: // /? Action = Actualizar algunos casos en algunos casos La documentación no se puede generar como en el caso siguiente identificado: Automodule no puede importar parte del proyecto cuando usamos el Automodule, AutoClass .. Directivas Algunos proyectos no pueden importar los requisitos o la configuración. Luego, Sphinx no generará la documentación del proyecto y devolverá el siguiente error: Lista de proyectos fuera de rango, como se refiere a la aplicación TurboGEARS. Actualmente estamos trabajando en este tema y esperamos tener una solución pronto.3. Documentación Navación en la barra lateral derecha del DOC SPHINX IN TRAC Encontraremos las tres funciones siguientes: * Tabla de contentMenú del contenido de la página mostrada actual. * Enlaces relativos, encierran el enlace del proyecto de índice y módulo, y los enlaces anteriores / próximos. * SearchSimple Sphinx como función de búsqueda. No hay javascript aquí realizamos la búsqueda en el lado del servidor.4. Descripción general de la API de URLEl complemento Administre las URL y los parámetros de seguimiento. Por defecto se mostrará la página de índice de la documentación del proyecto. * / / Sphinx Página de índice predeterminado * / / Sphinx? Acción = ViewItem = Acción = Ver acción para mostrar una página específica del elemento de documentación = Page_name Nombre de la página DIS PANTALLA DE LOCK_WORPS = PALABRAS DE La búsqueda actual (resaltada en la página) * / / Sphinx? Action = indexitem = genindex acción = índice Mostrar el elemento del índice de documentación del proyecto = Genindex Mostrar el Índice de documentación del proyecto * / / Sphinx? Acción = ModulesItem = ModIndex Acción = Mostrar índice El elemento del índice de los módulos del proyecto = GENInDEX Muestra el índice de los módulos del proyecto5. Siguiente UpdatestStHis Plugin Version Implementa funcionalidades básicas de la esfinge. No dude en enviar correos electrónicos o parches si tiene necesidades adicionales o si el complemento no administra su documentación de esfinge de la forma en que queremos. Requisitos: · Python
Tracsphinx Software relacionado
