Accéder à la documentation de django...
Par NiCoS le jeudi 5 octobre 2006, 23:34 - Python - Django - Lien permanent
Ce jour, dans le RER, en attendant mon train, j'étais en train de continuer ma découverte du framewok Django. Je me disais "quel dommage de pas avoir de connexion internet, je n'ai aucune doc et c'est donc dur de pouvoir avancer sur la découverte de django..." A ce moment là un lien "Documentation" dans l'admin attire mon oeil. Je clique dessus et là : rien car il me manque le paquet docutils comme la page l'indique si bien.
En revenant chez moi, je m'empresse donc de faire :
geshi bash sudo apt-get install python-docutils
Je relance webrick et me rend sur la page http://localhost:8000/admin/doc/ et là : que du bonheur !
Vous accédez à la doc de django (tag, filtes, vues, etc), ainsi qu'à une vision de vos modèles. Vous voyez ainsi tous vos modèles avec une description du type que vous avez défini. Cette représentation tient même compte des clés étrangères donc du coup, voyant le lien entre mon model "post" et "comment", il me propose des fonctionnalités croisées (lister tous les comments d'un post, etc).
Génial, non ?
Commentaires
Au pire, il y a le répertoire /doc des sources de django qui contient toute la doc du site (qu'il est possible de convertir avec rest2html pour une meilleure lecture).
C'est rst2html plutôt non ? D'ailleurs rst2html fait aussi partie du paquet python-docutils... c'est le serpent qui se mord la queue (sic)
Ok, merci pour l'astuce
Le paquet docutils, contient des scripts Python pour convertir une documentation (ou n'importe quel texte) écrit avec la syntaxe ReStructuredText.
Normalement en lisant la doc avec un simple éditeur ça fonctionne.
Tu peux lire la doc django au format texte en effet sans faire de transformation, c'est juste que c'est un peu plus joli en html
Pour que ce soit bien clair aussi, la doc fournie dans les sources et celles fournie dans l'admin n'est pas la même (il y a des recouvrements mais globalement, elle ne traite pas des mêmes points...)
Salut Nicos,
J'ai un petit script ( autre que rst2html ) qui peut convertir une source reST en HTML et qui utilise Pygments ( http://pygments.pocoo.org/ ) pour mettre les codes sources en couleur. Si ca t'interesse, tu peux me contacter.
Ah ouais sympa !
Je veux bien voir ça
Désolé NiCoS, je pensais que tu m'enverrai un mail...
C'est par ici, regarde l'aide avant, j'ai inclus un exemple et le rendu normalement obtenu avec une feuille de style perso (loin d'être complète). Evidemment, tu dois installer Pygments avant !
h**p://kib2.free.fr/reST_tools/
Bon courage, à plus :
Kib²
Je pensais t'en envoyer un en complément mais j'ai oublié
Je regarde ça asap !
++