TracSphinx Rangschikking & Samenvatting
- Naam uitgever:
- Florent PIGOUT
TracSphinx Tags
TracSphinx Beschrijving
SPHINX-plug-in voor TRAC 0.11 Eerste concept voor Sfinx zoals eenvoudig te gebruiken plug-in. TracSphinx implementeert basistaken om SPHINX-documentatie in TRAC.1 te beheren. Plug-in Installeer de pluginebronnen, knip het archief uit en typ de opdracht Easy_Install in de map Plugin: $ Easy_Install Setup.py InstallerRestart Het TRAC-project (en). Als administratie kan we nu de plug-in activeren. By de standaard de map Documentatie is './docs/source' van de projectrepository. Maar in de meeste van de gevallen zullen we dit pad opheffen in het -gedeelte van het bestand van het project 'Trac.ini': SONE_DIR = / Deze bronmap wordt door het project gebruikt om de SPHINX-documentatie te bouwen met behulp van de Webbouwer van Sphinx. Als de documentatie niet van TRAC kan worden gegenereerd, kunnen we het gegenereerde documentatiepad opgeven met de volgende optie: DOC_DIR = / We kunnen ook de NAVBAR-titel instellen met de volgende optie: NAVBAR_TITLE = MIJN DOCUMENTATIE2. Documentatie-updatesimple params in het project-URL om de documentatie bij te werken in de bronmap van het project naar de TRAC-projectmap './Sphinx-docs'. Typ gewoon de volgende URL voor update: http: // /? Actie = Vernieuwen van enkele gevallen De documentatie kan niet worden gegenereerd zoals in het geïdentificeerde volgende geval: Automodule kan geen deel van het project importeren wanneer we de automodule, autoclass gebruiken .. richtlijnen Sommige projecten kunnen niet importeren, moeten vereisten of configuratie. Dan zal SPHINX de projectdocumentatie niet genereren en de volgende fout retourneren: lijst buiten bereikprojecten zoals Turbogears-toepassing zijn betrokken. We werken momenteel aan dit probleem en hopen snel een oplossing op te doen.3. Documentatie Navigatie De rechter zijbalk van de SPHINX DOC in TRAC vinden wij de drie volgende functies: * Tabel met contentmenu van de inhoud van de huidige weergegeven pagina. * Relatieve LinksInclude De Index en Module Project Link en de vorige / Volgende Link (en). * SEARTSIMPLE SPHINX-achtige zoekfunctie. Geen JavaScript hier geven we de zoektocht op de serverzijde.4. URL API OverzichtDe plug-in beheren de volgende URL's en parameters. Standaard wordt de indexpagina van de projectdocumentatie weergegeven. * / / SPHINX standaard indexpagina * / / sphinx? Action = viewitem = actie = Bekijken actie om een specifieke pagina van het documentatiepunt te tonen = PAGE_NAME NAAM VAN DE PAGINA DOE DOE De huidige zoekopdracht (gemarkeerd op de pagina) * / / SPHINX? ACTION = INDEXITEM = GENINDEX ACTION = INDEX Toon de projectdocumentatie-index Item = Genindex Display De projectdocumentatie-index * / / SPHINX? ACTION = MODULESITEM = MODINDEX ACTION = Index Display Het projectmodules Index Item = Genindex Geef de projectmodules index5 weer. Volgende UpdateSthis Plugin-versie implementeert SPHINX basisfunctionaliteiten. Aarzel niet om e-mails of patches te verzenden als u nog meer nodig hebt of als de plug-in uw SPHINX-documentatie niet behaalt, zoals we dat willen. Vereisten: · Python
TracSphinx Gerelateerde software
