Comecei a brincar com o Django, “o” framework Python quando se trata de web. E como nem sempre estou com conexão disponível, resolvi ter também uma cópia local da documentação, para que eu possa consultá-la sempre que for preciso.
Pois bem, na página sobre a documentação do Django, vejo que os arquivos que preciso estão no diretório docs dentro da pasta criada ao descompactar o .tar.gz do mesmo. Para criar a documentação no formato HTML, basta instalar as ferramentas certas e fazer um
no diretório.
O Ubuntu já tem pacotes para as ferramentas que precisamos. Então basta um…
…para que possamos compilar a documentação.
Como nem tudo nessa vida é perfeito, existe um bug que impede que a documentação seja compilada utilizando o Sphinx 0.6 (que é a versão do pacote
do ubuntu). A boa botícia é que o problema já foi corrigido para a versão 1.1. Caso você esteja utilizando a combinação Sphinx 0.6 e Django 1.0.2 precisará de um patch específico para a versão 1.0.2 [1].
Primeiro, faça o download do arquivo de patch, disponível em http://files.getdropbox.com/u/1447299/patch-django-1.0.2.diff. Salve-o na raiz do seu diretório de usuário com o nome
. Na pasta onde você extraiu o conteúdo do .tar.gz do Django, faça:
Depois, basta seguir o procedimento normal, executando um make html no diretório docs/. A documentação será gerada no diretório
.
[1] Retirado de http://www.mail-archive.com/debian-bugs-dist@lists.debian.org/msg645050.html
