O Sphinx é um gerador de documentação usado pela comunidade da linguagem de programação Python. Ele é escrito em Python e também pode ser usado em outros ambientes.
Finalidade e função O Sphinx converte arquivos escritos em reStructuredText em sites HTML e outros formatos, incluindo PDF e EPub.
O reStructuredText é extensível, e o Sphinx possui diversas extensões – para gerar automaticamente documentação a partir do código-fonte, escrever notação matemática ou realçar o código-fonte, etc.
Temas HTML O Sphinx oferece a capacidade de aplicar temas ao HTML, possuindo vários temas integrados, incluindo alabaster, classic, sphinxdoc e scrolls. Temas populares que podem ser instalados como módulos Python incluem:
Read the Docs
Sphinx Bootstrap
Guzzle
Documatt
A primeira versão pública do Sphinx, versão 0.1.61611, foi anunciada em 21 de março de 2008. Ela foi desenvolvida para o projeto Python para documentação.
Desde a sua introdução, o framework foi adotado por muitos outros projetos relevantes em Python, como Bazaar, SQLAlchemy, MayaVi, SageMath, SciPy, Django e Pylons. O sistema também é usado para o manual do usuário do Blender e documentação da API Python.
Em 2010, Eric Holscher anunciou a criação do projeto Read the Docs para facilitar a manutenção da documentação do software. O Read the Docs automatiza o processo de construção e upload da documentação do Sphinx após cada commit em plataformas como o GitHub.
Kernel do Linux O sistema de documentação do kernel (núcleo) do Linux passou por alterações em 2016. A partir do ciclo 4.7, a documentação começou a usar o Sphinx.
Ver também
Read the Docs reStructuredText
Categoria:Software livre programado em Python