Um dos requisitos essenciais para quem vai entrar para o desenvolvimento web com Django, é a sua documentação oficial. É na documentação oficial do Django que encontramos todas as especificações deste Framework, desde as classes, métodos, exemplos e tudo mais que desejarmos para nos auxiliar no desenvolvimento das nossas aplicações web com o melhor Framework que já me apresentaram, que além de outras qualidades, é baseado numa das linguagens que eu mais adoro, o Python.Usuários do Windows tem a possibilidade de baixar uma cópia da documentação do site para ler offline, usando o programa Superbot que baixa sites completos e os torna acessíveis offline, mas no Ubuntu ainda não encontrei uma alternativa para esta tarefa.Um detalhe que eu ainda não tinha notado é que o pacote distribuido pelo site do Django já traz a documentação para a respectiva versão, mas está num formato ainda não compilado. No arquivo que você fez o download, você terá disponível um directório docs, com todas as páginas necessárias para a documentação. A única coisa que precisamos fazer, é compilar estes ficheiros para o formato que desejarmos, html, latex ou outros. Quando compilamos para html, teremos uma cópia completa da documentação do Django Online disponível para consulta offline.
Instalando as ferramentas necessárias
Primeiro precisaremos instalar alguns pacotes necessários para usar o comando make no Ubuntu, que será usado para criar a documentação do Django. Vamos fazer isso então, abra o terminal do Ubuntu e digite os seguintes comandos:
# apt-get install python-pygments python-jinja python-docutils python-setuptools # sudo easy_install Sphinx
Criando a documentação HTML do Django para a leitura Offline
Agora que já temos todas as ferramentas instaladas, vamos para o próximo passo do processo, que é criar a documentação do Django em si. Criaremos apenas a documentação HTML, e se quiser poderá usar os mesmos principios para criar outras versões.Primeiro Navegue usando o terminal, até ao directório onde está o Django que você fez o download. No meu caso tive de fazer:
# cd /home/backstageel/downloads/Programming/Django-1.1.1/docs
Note que fui até ao directório docs, onde está a documentação a compilar. Lá, basta digitar simplesmente o comando make, seguido de um argumento que é o formato da documentação. No meu caso, gerei a versão html da documentação, então foi só fazer:
# make html
O resto do processo é automático, só precisamos esperar tudo terminar. A documentação será colocada em _build/html.Colocando a documentação offline do Django no servidor localO último passo deste tutorial é opcional: Eu coloquei a minha documentação do Django dentro do meu servidor local, assim acesso como se estivesse online, sem complicações. É só usar comandos do ubuntu para copiar o conteúdo do directório _build/html para o servidor local, que no meu caso está localizado em /var/www/:
#mv _build/html/ /var/www/django-docs
Prontos, boas leituras e bom desenvolvimento!
Comentários Recentes