SPHINX – Uma Ferramenta Estrutural de Documentação

Já ficou na dúvida de como documentar o seu projeto?

Escolher entre wiki, blog, evernote ou word? Realmente não é uma tarefa tão fácil como pode parecer no primeiro momento.

Principalmente se você está iniciando nessa área de desenvolvimento. Por esse motivo segue uma dica de uma forma de documentação utilizada pelo projeto python, o Sphinx!

Sphinx é uma ferramenta que permite que desenvolvedores criem documentação em texto simples para geração fácil de saída em formatos que atendem a necessidades variadas.

  • Isso é útil ao usar um Sistema de Controle de Versão para controlar mudanças.
  • Documentação em texto simples também é útil para colaboradores em diferentes sistemas.
  • Texto simples é um dos formatos mais móveis disponíveis atualmente.

Embora o Sphinx tenha sido escrito em Python e tenha sido originalmente criado para a documentação da linguagem Python, não é necessariamente centrado em linguagem e, em alguns casos, nem mesmo específico para programadores. Há muitos usos para o Sphinx, como escrever livros inteiros!

INSTALAÇÃO

 

É necessário ter o python instalado com a versão 2.7 ou superior

INSTALAR PIP

INSTALAR SPHINX

INSTALAR TEMA

Escolha sempre a ultima versão do tema, que pode ser visto aqui:  https://sphinx-rtd-theme.readthedocs.io/en/latest/

CONFIGURAÇÃO

 

Editar o arquivo conf.py modificando a flag “html_theme”

Segue um exemplo do tema abaixo:

INICIALIZANDO A DOCUMENTAÇÃO

 

Criar uma pasta e execute o seguinte comando dentro dela:

REFERÊNCIAS

 

Documentação oficial do SPHINX. Disponível em: <http://www.sphinx-doc.org/pt_BR/master/contents.html>. Acesso em 14 de Feverreiro de 2018.

IBM developer works. Disponível em: <https://www.ibm.com/developerworks/br/library/os-sphinx-documentation/index.html>. Acesso em 14 de Feverreiro de 2018.

Youtube, Instalação e uso básico do Sphinx. Disponível em: <https://www.youtube.com/watch?v=YT_A34-Tmks>. Acesso em 14 de Feverreiro de 2018.

 

Related posts:

Interessante? Compartilhe!

Leave a Comment

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *