Repolode
Enviar
sphinx-doc

sphinx-doc/sphinx

Gerador de documentação para Python que cria HTML, PDF, EPUB e outros formatos a partir de fontes em reStructuredText ou Markdown.

Ver no GitHubSite
Estrelas
8,072
Forks
2,610
Issues abertas
1,453
Último commit
há 7 horas

O que é?

Sphinx é um gerador de documentação que transforma arquivos-fonte em reStructuredText em documentação bem acabada. Ele oferece saída em HTML, PDF, texto simples, EPUB, TeX e páginas de manual, e é baseado no Docutils para fazer o parsing e a tradução.

A ferramenta dá destaque a referências cruzadas e à estrutura dos documentos. É possível criar links semânticos para funções, classes, termos de glossário e outros objetos, e os documentos formam uma árvore com links automáticos entre páginas irmãs, pais e filhas. Sphinx também gera índices gerais e de módulos automaticamente.

Sphinx faz o realce de código com Pygments e renderiza HTML usando o mecanismo de templates Jinja 2. Seu ecossistema de extensões adiciona recursos como documentação automática de funções, suporte a notebooks Jupyter e domínios de linguagem para Python, C, C++, JavaScript e matemática.

Recursos principais

  • 01Gera HTML, PDF, texto simples, EPUB, TeX e páginas de manual
  • 02Oferece referências cruzadas semânticas para funções, classes e termos de glossário
  • 03Organiza documentos em árvores com links automáticos entre páginas relacionadas
  • 04Gera índices gerais e de módulos automaticamente
  • 05Realça código com Pygments e renderiza HTML usando templates Jinja 2
  • 06Pode ser ampliado por um ecossistema de plugins, incluindo suporte a linguagens como Python, C, C++ e JavaScript

Casos de uso

  • Publicar a documentação de referência da API de uma biblioteca Python
  • Escrever manuais técnicos que precisam ser gerados em PDF e HTML a partir de uma única fonte
  • Manter documentação de projetos multilíngue ou com versões, usando referências cruzadas

Início rápido

  1. 1

    Instale o Sphinx do PyPI com pip

    pip install -U sphinx

Antes de usar

  • O README não informa um nome de licença claro; os metadados a listam como NOASSERTION, embora o selo indique BSD 2-Clause.

Tópicos

#documentation#restructuredtext#python#docs-generator#html#pdf#docs#documentation-tool#markdown#sphinx

Perguntas frequentes

O que é sphinx?
Gerador de documentação para Python que cria HTML, PDF, EPUB e outros formatos a partir de fontes em reStructuredText ou Markdown. Sphinx é um gerador de documentação que transforma arquivos-fonte em reStructuredText em documentação bem acabada. Ele oferece saída em HTML, PDF, texto simples, EPUB, TeX e páginas de manual, e é baseado no Docutils para fazer o parsing e a tradução.
sphinx é gratuito? Qual é a licença?
sphinx é open source sob a licença Other. Confira os termos da licença antes de usá-lo em produtos comerciais.
sphinx ainda é mantido?
Manutenção ativa. O último commit de sphinx foi em 22 de out. de 2026.
Para que posso usar sphinx?
Publicar a documentação de referência da API de uma biblioteca Python Escrever manuais técnicos que precisam ser gerados em PDF e HTML a partir de uma única fonte Manter documentação de projetos multilíngue ou com versões, usando referências cruzadas
Como instalar sphinx?
Instale o Sphinx do PyPI com pip: pip install -U sphinx
Onde consigo sphinx?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/sphinx-doc/sphinx

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados