Gerando a documentação do Django para usar offline

A documentação disponível no site do django é muito bem organizada, bem escrita e rica em exemplos. O tutorial para iniciantes é fantástico.

É normal ter que recorrer a documentação no site do django no dia a dia, e para quem tem uma conexão direta com a internet, estável e de qualidade, acaba sendo mais prático realizar esta consulta online.

Mas para aqueles desenvolvedores que não tem disponível conexão de internet ou usa conexão discada, OU USA O SPEEDY (heheheh boa hein) uma saída é usar a versão 'local' da documentação que encontra-se no diretório docs, dentro do diretório do django.

Só que ela não vem pronta para usar. É necessário compilar os documentos para algum formato (html, latex, ...). Para isso é necessário ter o Sphinx[1] (Python Documentation Generator) instalado. A forma mais rápida e simples é através do Easy Install:

$ easy_install -U Sphinx

Para usar o easy_install é necessário instalar o pacote setuptools[2].
Tanto no openSUSE quanto no Ubuntu o nome do pacote é python-setuptools.

openSUSE: $ sudo zypper in python-setuptools
Mint/Ubuntu: $ sudo apt-get install python-setuptools

Agora é gerar a documentação. Dentro do diretório "docs" execute:
$ make html

Ele vai gerar a documentação dentro do diretório _build/html. Para ler basta:
$ firefox _build/html/index.html

Boa leitura!

[1] sphinx.pocoo.org/
[2] http://peak.telecommunity.com/DevCenter/setuptools