davidbgk
/
larlet-fr-david

<!doctype html>
<html lang=fr>
<head>
  <!-- Always define the charset before the title -->
  <meta charset=utf-8>
  <title>La documentation Django en local (html et pdf) — Biologeek — David Larlet</title>
  <!-- Define a viewport to mobile devices to use - telling the browser to assume that the page is as wide as the device (width=device-width) and setting the initial page zoom level to be 1 (initial-scale=1.0) -->
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <!-- Fake favicon, to avoid extra request to the server -->
  <link rel="icon" href="data:;base64,iVBORw0KGgo=">
  <link type="application/atom+xml" rel="alternate" title="Feed" href="/david/log/" />
  <link rel="manifest" href="/manifest.json">
  
  <link rel="stylesheet" href="/static/david/css/larlet-david-_J6Rv.css" data-instant-track />
  
  <noscript>
    <style type="text/css">
      /* Otherwise fonts are loaded by JS for faster initial rendering. See scripts at the bottom. */
      body {
        font-family: 'EquityTextB', serif;
      }
      h1, h2, h3, h4, h5, h6, time, nav a, nav a:link, nav a:visited {
        font-family: 'EquityCapsB', sans-serif;
        font-variant: normal;
      }
    </style>
  </noscript>
  
  <!-- Canonical URL for SEO purposes -->
  <link rel="canonical" href="https://larlet.fr/david/biologeek/archives/20081204-la-documentation-django-en-local-html-et-pdf">

</head>
<body>
  <div>
    
    <header>
      <nav>
        <p>
          <small>
            Je suis <a href="/david/" title="Profil public">David Larlet</a>, <a href="/david/pro/" title="Activité professionnelle">artisan</a> du web qui vous <a href="/david/pro/accompagnement/" title="Activité d’accompagnement">accompagne</a><span class="more-infos"> dans l’acquisition de savoirs pour concevoir des <a href="/david/pro/produits-essentiels/" title="Qu’est-ce qu’un produit essentiel ?">produits essentiels</a></span>. <span class="more-more-infos">Discutons ensemble d’une <a href="/david/pro/devis/" title="En savoir plus">non-demande de devis</a>.</span> Je partage ici mes <a href="/david/blog/" title="Expériences bienveillantes">réflexions</a> et <a href="/david/correspondances/2017/" title="Lettres hebdomadaires">correspondances</a>.
          </small>
        </p>
      </nav>
    </header>
    
    
  <section>
    <h1 property="schema:name">La documentation Django en local (html et pdf)</h1>
    <article typeof="schema:BlogPosting">
      <div property="schema:articleBody">
        
        <p>Le <a href="http://prendreuncafe.com/blog/post/2008/12/04/Fayotage">billet de NiKo m'a rappelé que Glooze</a> 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).</p>
<h2>Pré-requis</h2>
<ul>
<li>installer <a href="http://sphinx.pocoo.org/">sphinx</a> (easy_install sphinx ou avec votre méthode préférée) ;</li>
<li>installer latex (avec <a href="http://tug.org/mactex/">MacTeX</a> ou avec <a href="http://www.valhalla.fr/2007/10/08/latex-sur-mac-installation/">une bonne doc</a> si vous êtes sous mac, dans les deux cas c'est looooong).</li>
</ul>
<p>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à...</p>
<h2>3 étapes</h2>
<ul>
<li>récupérer <a href="http://www.djangoproject.com/download/">les sources de Django</a> et les décompresser ;</li>
<li>
<p>aller dans le dossier docs et lancer la commande sphinx-build appropriée, pour la version html : <strong>sphinx-build . build_html</strong></p>
</li>
<li>
<p>et pour la version pdf : <strong>sphinx-build -b latex . build_latex</strong></p>
</li>
<li>
<p>générer le pdf à partir du latex : <strong>latex build_latex/django.tex django.pdf</strong></p>
</li>
</ul>
<p>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 !</p>
<p>À ce sujet, <a href="http://www.python.org/download/releases/3.0/">Python 3 est sorti aujourd'hui</a>, 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 à <a href="http://groups.google.com/group/django-developers/browse_thread/thread/dcf70c736c204594/a0686368119096b9">définir des roadmaps</a>. La migration est grandement facilitée par l'<a href="http://docs.python.org/dev/3.0/library/2to3.html#to3-reference">utilitaire 2to3</a> et par les warnings affichés lors de l'utilisation de votre code avec Python 2.6, ça devrait pas être si terrible ;-).</p>
      </div>
    </article>
    <footer>
      <h6 property="schema:datePublished">— 04/12/2008</h6>
    </footer>
  </section>
  <section>
    <div>
      <h3>Articles peut-être en rapport</h3>
      <ul>
        <li><a href="/david/biologeek/archives/20081203-interfaces-et-promotion-du-web-semantique/" title="Accès à Interfaces et promotion du Web Sémantique">Interfaces et promotion du Web Sémantique</a></li>
        <li><a href="/david/biologeek/archives/20081201-24ways-le-calendrier-de-lavant-des-geeks-web/" title="Accès à 24ways, le calendrier de l&#39;Avent des geeks web">24ways, le calendrier de l&#39;Avent des geeks web</a></li>
        <li><a href="/david/biologeek/archives/20081126-loi-de-geek/" title="Accès à Loi de Geek">Loi de Geek</a></li>
      </ul>
    </div>
  </section>
  <section>
    <div id="comments">
      <h3>Commentaires</h3>
      
<div class="comment" typeof="schema:UserComments">
    <p class="comment-meta">
        <span class="comment-author" property="schema:creator">er:k</span> le <span class="comment-date" property="schema:commentTime">04/12/2008</span> :
    </p>
    <div class="comment-content" property="schema:commentText">
        <p>Merci pour cette info, même si je ne trouve pas non plus personellement d&#39;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 :)</p>

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

<p>ps : merci encore pour l&#39;astuce sur la gestion des menus actifs dans les templates Django (cf ce site)</p>
    </div>
</div>
<div class="comment" typeof="schema:UserComments">
    <p class="comment-meta">
        <span class="comment-author" property="schema:creator">Goulwen</span> le <span class="comment-date" property="schema:commentTime">04/12/2008</span> :
    </p>
    <div class="comment-content" property="schema:commentText">
        <p>Sympa !</p>

<p>Je me suis arrêté à la version HTML qui me semble de toutes façons la plus pratique quand j&#39;ai vu que MacTex fait 1,15Go ! Bon il y a un package à 48Mo mais quand même ! Quand à Sphinx, je l&#39;ai installé avec MacPorts, ça n&#39;a pas pris des heures (ni même des minutes)</p>
    </div>
</div>
<div class="comment" typeof="schema:UserComments">
    <p class="comment-meta">
        <span class="comment-author" property="schema:creator">NiCoS</span> le <span class="comment-date" property="schema:commentTime">05/12/2008</span> :
    </p>
    <div class="comment-content" property="schema:commentText">
        <p>Pour la convertion en HTML, il y a aussi la solution de faire un simple &quot;make html&quot; lorsque l&#39;on est au niveau du fichier Makefile généré par Sphinx.</p>
    </div>
</div>

    </div>
  </section>

    
    <footer>
      <nav>
        <p>
          <small>
            Je réponds quasiment toujours aux <a href="m&#x61;ilto:d&#x61;vid%40l&#x61;rlet&#46;fr" title="Envoyer un email">emails</a> (<a href="/david/signature/" title="Ma signature actuelle avec possibilité de chiffrement">signés</a>) et vous pouvez me rencontrer à Montréal. <span class="more-infos">N’hésitez pas à <a href="/david/log/" title="Être tenu informé des mises à jour">vous abonner</a> pour être tenu informé des publications récentes.</span>
          </small>
        </p>
      </nav>
    </footer>
    
  </div>
  
  <script src="/static/david/js/larlet-david-3ee43f.js" data-no-instant></script>
  
  <script data-no-instant>InstantClick.init()</script>
  
</body>
</html>