TRACSPHINX. Ranking & Zusammenfassung
- Name des Herausgebers:
- Florent PIGOUT
TRACSPHINX. Stichworte
TRACSPHINX. Beschreibung
Sphinx-Plugin für Trac 0.11 Erster Entwurf für Sphinx wie einfach zu bedienendes Plugin. Tracsphinx implementiert grundlegende Aufgaben zur Verwaltung der Sphinx-Dokumentation in Trac.1. Plugin installieren Sie die Plugin-Quellen, entpacken Sie das Archivieren und geben Sie den Befehl Easy_install aus dem Plugin-Ordner ein: $ easy_install setup.py installRestart Das Trac-Projekt (e). Als Verabreicher können wir jetzt das PlugIn.by-Standard aktivieren. Der Dokumentations-Quellordner ist './docs/source' des Projekt-Repositorys. In den meisten Fällen werden wir jedoch diesen Pfad im Abschnitt des Projekts "trac.ini" -Datei überschreiben: source_dir = / Dieser Quellordner wird vom Projekt verwendet, um die Sphinx-Dokumentation mit der Webbauer von Sphinx. Wenn die Dokumentation nicht aus der TRAC generiert werden kann, können wir den generierten Dokumentationspfad mit der folgenden Option angeben: doc_dir = / Wir können den NavBar-Titel auch mit der folgenden Option einstellen: Navbar_title = Meine Dokumentation2. Dokumentation UpdateSimple-Parameter in die Projekt-URL, um die Dokumentation des Quellordners des Projekts in den Trac-Projektordner "./sphinx-docs" zu aktualisieren. Geben Sie einfach die folgende URL ein, um das Update zu aktualisieren: .. Richtlinien Einige Projekte können nicht importieren Muss Anforderungen oder CONFIG. Dann generiert Sphinx nicht die Projektdokumentation und gibt den folgenden Fehler zurück: Liste von Range-Projekten wie TurboGears-Anwendungen sind betroffen. Wir arbeiten derzeit an diesem Thema und hoffen, dass sie bald eine Lösung sorgen. Dokumentation Navigation In der rechten Seitenleiste des Sphinx-Dokuments in TRAC finden Sie die drei folgenden Funktionen: * Tabelle des ContentMenu des Inhalts der aktuell angezeigten Seite. * Relative LinksInclude den Index- und Modul-Projektlink und den vorherigen / nächsten Link (en). * SEARCHE SUCHSTEHLE SPHINX Wie Suchfunktion. Kein JavaScript Hier führen wir die Suche auf der Serverseite aus. URL-API-ÜbersichtDas Plugin Verwalten Sie die folgenden URLs und -parameter. Standardmäßig wird die Indexseite der Projektdokumentation angezeigt. * / / sphinx Standardindexseite * / / Sphinx? Action = ViewItem = Action = Aktion anzeigen Um eine bestimmte Seite der Dokumentation einzeln anzeigen) Die aktuelle Suche (auf der Seite hervorgehoben) * / / Sphinx? Action = IndexItem = GENINDEX Action = Indexanzeige Der Projektdokumentation Index Element = GENINDEX Anzeige der Projektdokumentation Index * / / Sphinx? Action = ModuleSitem = MODINDEX Action = Indexanzeige Die Projektmodule Index item = GENINDEX Zeigt die Projektmodule index5 an. Nächste UpdateAsthis-Plugin-Version implementiert Sphinx-Basisfunktionalitäten. Bitte zögern Sie nicht, E-Mails oder Patches zu senden, wenn Sie weitere Anforderungen haben oder wenn das Plugin Ihre Sphinx-Dokumentation nicht so verwaltet, wie wir möchten. Anforderungen: · Python
TRACSPHINX. Zugehörige Software
