Boas-vindas

Sphinx facilita criar uma documentação inteligente e bonita.

Aqui estão alguns dos principais recursos do Sphinx:

  • Formatos de saída: HTML (incluindo Windows HTML Help), LaTeX (para versões PDF imprimíveis), ePub, Texinfo, páginas de manual, texto simples

  • Referências cruzadas extensas: marcação semântica e links automáticos para funções, classes, citações, termos de glossário e informações semelhantes

  • Estrutura hierárquica: fácil definição de uma árvore de documentos, com links automáticos para documentos irmãos, pais e filhos

  • Índices automáticos: índice geral, bem como índices de módulo específicos do idioma

  • Manuseio de código: realce automático usando o marcador Pygments

  • Extensões: teste automático de trechos de código, inclusão de docstrings de módulos Python (documentos de API) por meio de extensões embutidas e muito mais funcionalidades por meio de extensões de terceiros.

  • Temas: modifique a aparência das saídas via criando temas e reutilize muitos temas de terceiros.

  • Extensões contribuídas: dezenas de extensões contribuídas por usuários; a maioria delas instalável a partir do PyPI.

Sphinx usa a linguagem de marcação reStructuredText por padrão, e pode ler marcação MyST através de extensões de terceiros. Ambos são poderosos e fáceis de usar, e têm funcionalidade para documentação complexa e fluxos de trabalho de publicação. Ambos se baseiam no Docutils para analisar e escrever documentos.

Veja abaixo como navegar na documentação do Sphinx.

Ver também

A tabela de conteúdo da documentação do Sphinx tem uma lista completa das páginas deste site.

Primeiros passos

Essas seções cobrem os conceitos básicos de introdução ao Sphinx, incluindo a criação e construção de sua própria documentação a partir do zero.

Guias de usuário

Estas seções cobrem vários tópicos no uso e extensão do Sphinx para vários casos de uso. Eles são um guia abrangente para usar o Sphinx em muitos contextos e pressupõem mais conhecimento do Sphinx. Se você é novo no Sphinx, recomendamos começar com Primeiros passos.

Guia comunitário

Sphinx é apoiado pela comunidade e aceita contribuições de qualquer pessoa. As seções abaixo devem ajudar você a começar a se juntar à comunidade Sphinx, além de contribuir.

Veja o Guia dos contribuidores do Sphinx se você quiser contribuir para o projeto.

Guia de referência

A documentação de referência é mais completa e programática por natureza, é uma coleção de informações que podem ser rapidamente referenciadas. Se você quiser documentação orientada a casos de uso, veja Primeiros passos ou Guias de usuário.