# La documentation Django en local (html et pdf)

Le billet de NiKo m'a rappelé que Glooze voulait avoir un pdf de la documentation de Django, ça prend 3 minutes (ou 3 heures, ça dépend de votre connexion et de votre processeur).

## Pré-requis

- installer sphinx (easy_install sphinx ou avec votre méthode préférée) ;
- installer latex (avec MacTeX ou avec une bonne doc si vous êtes sous mac, dans les deux cas c'est looooong).

Si vous êtes sous une distribution GNU/Linux ça devrait être plus rapide avec votre gestionnaire de paquets préféré, oui OS X a bien du retard à ce niveau là...

## 3 étapes

- récupérer les sources de Django et les décompresser ;

- aller dans le dossier docs et lancer la commande sphinx-build appropriée, pour la version html : sphinx-build . build_html

- et pour la version pdf : sphinx-build -b latex . build_latex

- générer le pdf à partir du latex : latex build_latex/django.tex django.pdf

Et voilà, vous avez un pdf de la documentation Django qui fait 700 pages et qui n'est pas super bien mis en forme (notamment le code...) mais ça peut dépanner. Si vraiment ça vous passionne, vous pouvez faire votre propre feuille de styles qui s'applique lors de la conversion mais bon j'ai déjà du mal à voir un intérêt au pdf... la version html est beaucoup mieux !

À ce sujet, Python 3 est sorti aujourd'hui, on va voir s'il est envisageable de sortir une version non compatible (nativement) avec la précédente sans tuer un langage, en tout cas les gros projets commencent à définir des roadmaps. La migration est grandement facilitée par l'utilitaire 2to3 et par les warnings affichés lors de l'utilisation de votre code avec Python 2.6, ça devrait pas être si terrible ;-).

### Articles peut-être en rapport

- Interfaces et promotion du Web Sémantique
- 24ways, le calendrier de l'Avent des geeks web
- Loi de Geek

### Commentaires

er:k le 04/12/2008 :

Merci pour cette info, même si je ne trouve pas non plus personellement d'intérêt à avoir un PDF (les html me suffisent), ça peut servir à certains, et ça explique aux gens comment générer la doc :)

Pour ce qui est de python 3... ouais, sacré nouvelle ! je ne m'attendais pas à une sortie si tôt. Reste plus qu'à attendre l'arrivée sous Debian et voir les nouveautés d'intérêt. (et l'arrivée d'un Django compatible :)

ps : merci encore pour l'astuce sur la gestion des menus actifs dans les templates Django (cf ce site)

Goulwen le 04/12/2008 :

Sympa !

Je me suis arrêté à la version HTML qui me semble de toutes façons la plus pratique quand j'ai vu que MacTex fait 1,15Go ! Bon il y a un package à 48Mo mais quand même ! Quand à Sphinx, je l'ai installé avec MacPorts, ça n'a pas pris des heures (ni même des minutes)

NiCoS le 05/12/2008 :

Pour la convertion en HTML, il y a aussi la solution de faire un simple "make html" lorsque l'on est au niveau du fichier Makefile généré par Sphinx.