Configuração inicial:

  • Instalar o sphinx através do pip install -U Sphinx
  • Instalar o tema do read the docs pip install sphinx_rtd_theme

1. Criação da pasta docs de simples.

No terminal:

foo@bar:~/simples$ mkdir docs
foo@bar:~/simples$ cd docs
foo@bar:~/simples/docs$ sphinx-quickstart
foo@bar:~/simples/docs$ sphinx-apidoc -f -o source/ ../simples

2. Mudanças no arquivo conf.py

No arquivo conf.py dentro da pasta docs, realizar as seguintes mudanças:

  • Descomentar essa linha e modificar o caminho:

    import os
import sys
sys.path.insert(0, os.path.abspath('../'))

  • Em extensões:

    extensions = ['sphinx.ext.autodoc',
            'sphinx.ext.napoleon'
]

  • E trocar o tema do html em:

    html_theme = 'sphinx_rtd_theme'

3. Alterar o arquivo index.rst

No arquivo index.rst adicionar a seguinte linha source/modules:

.. toctree::
:maxdepth: 2
:caption: Contents:

source/modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

4. Resultado

Por fim, na pasta docs, no terminal execute make html, o html é gerado no caminho docs/_build/html:

foo@bar:~/simples/docs$ make html