Sphinx (software)
| Sphinx (software) | |
|---|---|
| Lançamento estável | 9.1.0
/ 31 dezembro 2025 |
| Repositório | https://github.com/sphinx-doc/sphinx |
| Escrito em | Python |
| Licença | 2-clause BSD License |
| Website | https://www.sphinx-doc.org, http://sphinx-doc.org/ |
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. [1] Temas populares que podem ser instalados como módulos Python incluem: [2]
- Read the Docs[3]
- Guzzle[5]
- Documatt[6]
A primeira versão pública do Sphinx, versão 0.1.61611, foi anunciada em 21 de março de 2008. [7] Ela foi desenvolvida para o projeto Python para documentação. [8]
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 [9] e documentação da API Python. [10]
Em 2010, Eric Holscher anunciou a criação do projeto Read the Docs para facilitar a manutenção da documentação do software.[11] 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. [12]
Ver também
Referências
- ↑ «HTML Theming». Sphinx documentation. Georg Brandl and the Sphinx team. Consultado em 25 de junho de 2022
- ↑ «Sphinx Themes». Write the Docs. Consultado em 25 de junho de 2022
- ↑ «Read the Docs Sphinx Theme». sphinx-rtd-theme code repository. GitHub. Consultado em 25 de junho de 2022
- ↑ «Sphinx Bootstrap Theme». sphinx_bootstrap_theme code repository. GitHub. Consultado em 25 de junho de 2022
- ↑ «Guzzle Sphinx Theme». guzzle_sphinx_theme code repository. GitHub. Consultado em 25 de junho de 2022
- ↑ «Documatt Sphinx Themes Collection». Documatt.com. Consultado em 25 de junho de 2022
- ↑ «Sphinx is released! » And now for something completely Pythonic...». And now for something completely Pythonic... Georg Brandl. Consultado em 3 de abril de 2011. Arquivado do original em 22 de março de 2012
- ↑ «About these documents — Python v2.7.1 documentation». Python documentation. Python Software Foundation. Consultado em 3 de abril de 2011
- ↑ «Blender User Manual». Blender Wiki. Blender Foundation
- ↑ «Dev:2.5/Py/API/Generating API Reference - BlenderWiki!». Blender Foundation
- ↑ «Announcing Read The Docs». Python Software Foundation News. Eric Holscher. Consultado em 15 de fevereiro de 2015
- ↑ «Kernel documentation update». LWN.net. 2 de novembro de 2016