Tracsphinx. Classifica e riepilogo
- Nome editore:
- Florent PIGOUT
Tracsphinx. Tag
Tracsphinx. Descrizione
Plugin Sphinx per TRAC 0.11 Prima bozza per Sphinx come plugin facile da usare. Tracsphinx implementa attività di base per gestire la documentazione Sphinx in TRAC.1. Plugin InstallDownload Le fonti del plugin, decomprimere l'archivio e digitare il comando Easy_Install dalla cartella Plugin: $ Easy_install Setup.py installRestart I progetti TRAC. Come amministratore possiamo ora attivare il plugin.by Default La cartella di origine della documentazione è './docs/source' del repository del progetto. Ma nella maggior parte dei casi sovrascriveremo questo percorso nella sezione del file del progetto "trac.ini": SOURGE_DIR = / Questa cartella di origine viene utilizzata dal progetto per creare la documentazione Sphinx usando Builder Web della Sfinge. Se la documentazione non può essere generata da TRAC, possiamo specificare il percorso di documentazione generato con la seguente opzione: DOC_DIR = / possiamo anche impostare il titolo del navigazione con la seguente opzione: NAVBAR_TITLE = My Documentation2. Documentazione Aggiornamento dei parametri nell'URL del progetto Per aggiornare la documentazione dalla cartella di origine del progetto alla cartella del progetto TRAC './sphinx-docs'. Basta digitare il seguente URL per l'aggiornamento: http: // /? Azione = ACQUIRZIONE Alcuni casi La documentazione non può essere generata come nella causa seguente: Automodule non può importare parte del progetto quando usiamo l'automodule, autoclass .. Direttive Alcuni progetti non possono importare esigenze o config. Quindi Sphinx non genererà la documentazione del progetto e restituirà il seguente errore: Elenco fuori dai progetti range come l'applicazione TurboGears sono interessati. Attualmente stiamo lavorando a questo tema e speriamo di scoprire una soluzione presto.3. Documentazione navigazione La barra laterale destra della Sfinge Doc in TRAC troveremo le tre seguenti funzioni: * Tabella del contentMenu del contenuto della pagina visualizzata corrente. * Link relativaINClude il collegamento del progetto dell'indice e del modulo e il link (s) precedente / successivo / i. * Searchsimple Sphinx come la funzione di ricerca. Nessun JavaScript qui eseguiamo la ricerca sul lato server.4. URL API Panoramica Il plugin Gestisce i seguenti URL e parametri. Per impostazione predefinita verrà visualizzata la pagina dell'indice della documentazione del progetto. * / / Sphinx Pagina indice predefinita * / / Sphinx? Azione = ViewItem = Azione = Visualizza Azione Per visualizzare una pagina specifica della documentazione Elemento = Pagina_Name Nome della pagina DOWARD_WORD_WORDS = parole di La ricerca corrente (evidenziata nella pagina) * / / sphinx? azione = indexITEM = GENINDEX ACTION = DESLAY DISCLUSIONE DELLA DOCUMENTAZIONE DEL PROGETTO INDICE ITEM = GENINDEX Visualizza l'indice della documentazione del progetto * / / Sphinx? Azione = ModulesItem = MODINDEX ACTION = Indice Visualizzazione dei moduli di progetto I elemento indice = Genindex Visualizza i moduli del progetto Indice5. La prossima versione di updateshis plugin implementa le funzionalità di base Sphinx.Siepitare a non esitare a inviare e-mail o patch se hai ulteriori esigenze o se il plugin non gestisce la documentazione Sphinx nel modo in cui vogliamo. Requisiti: · Python.
Tracsphinx. Software correlato
