Tracsphinx Classement & Résumé
- Nom de l'éditeur:
- Florent PIGOUT
Tracsphinx Mots clés
Tracsphinx La description
Plugin Sphinx pour TRAC 0.11 Premier projet pour Sphinx comme plugin facile à utiliser. Tracsphinx implémente des tâches de base pour gérer la documentation Sphinx dans TRAC.1. Plugin Installdownload Les sources du plug-in, décompressez l'archive et tapez la commande easy_install dans le dossier du plug-in: $ easy_install setup.py installRestart le (s) projet (s) de TRAC. En tant qu'administrateur, nous pouvons désormais activer le plugin.by par défaut, le dossier de la source de documentation est "./docs/source" du référentiel de projet. Mais dans la plupart des cas, nous allons remplacer ce chemin dans la section du fichier "TRAC.INI" du projet: Source_Dir = / Ce dossier source est utilisé par le projet pour créer la documentation Sphinx à l'aide de la Web Builder of Sphinx. Si la documentation ne peut pas être générée à partir de TRAC, nous pouvons spécifier le chemin de documentation généré avec l'option suivante: doc_dir = / Nous pouvons également définir le titre NAVBARD avec l'option suivante: NAVBAR_TITTLE = Ma Documentation2. Documentation Mise à jour des paramètresImples dans l'URL du projet pour mettre à jour la documentation du dossier source du projet au dossier du projet TRAC './sphinx-docs'. Tapez simplement l'URL suivante pour la mise à jour: http: // /? Action = Rafraîchissez quelques cas La documentation ne peut pas être générée comme dans le cas suivant identifié: L'automodule ne peut pas importer une partie du projet lorsque nous utilisons l'automodule, l'autoclass .. Directives Certains projets ne peuvent pas importer doivent être configurés ou configuration. Ensuite, Sphinx ne générera pas la documentation du projet et ne renvoie pas l'erreur suivante: liste des projets hors de portée telles que les applications turbogears sont concernées. Nous travaillons actuellement sur cette question et espérons avoir bientôt une solution. Documentation NAVIGIGIATIONN La barre latérale droite de la DOC Sphinx dans Trac Nous trouverons les trois fonctions suivantes: * Tableau de contenuMenu du contenu de la page actuelle affichée. * Links relatifsIncrivez le lien de projet Index et Module, ainsi que le (s) lien précédent / suivant (s). * SearchSimple sphinx comme fonction de recherche. Pas de JavaScript ici, nous effectuons la recherche sur le côté serveur.4. Vue d'ensemble de l'API URLLe plugin gère les URL et les paramètres de suivi. Par défaut, la page d'index de la documentation du projet sera affichée. * / / Sphinx Par défaut Index Page * / / SPHINX? Action = videoM = action = Afficher l'action Pour afficher une page spécifique de l'élément de documentation = nom_name Nom de la page Do Display Recherche_Works = Mots de La recherche actuelle (surlignée dans la page) * / / Sphinx? Action = indexItem = Genindex Action = Index Afficher l'index de la documentation du projet = GeninDex Affiche l'index de la documentation du projet * / / SPHINX? Action = modulesItem = MODIDEX Action = Index Afficher l'élément d'index des modules de projet = GeninDex Affiche les modules de projet Index5. Suivant UpdatestHis Plugin Version implémente les fonctionnalités de base SPHINX.Veuillez n'hésiter pas à envoyer des courriels ou des correctifs si vous avez des besoins supplémentaires ou si le plugin ne gère pas votre documentation Sphinx comme nous le souhaitons. Exigences: · Python
Tracsphinx Logiciels associés
