Criando documentação

Esta seção cobre o básico de como criar documentação usando Sphinx e hospedar a documentação gratuitamente em Read The Docs.

Instalando o Sphinx

Use pip para instalar o Sphinx:

Unix/macOS

python3 -m pip install --upgrade sphinx

Windows

py -m pip install --upgrade sphinx

Para outros métodos de instalação, veja esta guia de instalação do Sphinx.

Primeiros passos com Sphinx

Crie um diretório docs dentro de seu projeto para conter sua documentação:

cd /path/to/project
mkdir docs

Execute sphinx-quickstart dentro do diretório docs:

cd docs
sphinx-quickstart

Isso configura um diretório fonte, orienta você por algumas configurações básicas e cria um arquivo index.rst, bem como um arquivo conf.py.

Você pode adicionar algumas informações sobre o seu projeto em index.rst e, em seguida, construí-las:

make html

Para mais detalhes sobre o processo de construção, veja o guia do Read The Docs.

Outras fontes

Para um guia mais detalhado sobre como usar o Sphinx e o reStructuredText, consulte este tutorial de documentação no Guia do Mochileiro para Python.