Usando Sphinx

Este guia serve para demonstrar como começar a usar o Sphinx e cobre tudo, desde a instalação do Sphinx e configuração do seu primeiro projeto Sphinx até o uso de alguns dos recursos avançados que o Sphinx fornece pronto para uso. Se você está procurando orientação sobre como estender o Sphinx, consulte Estendendo o Sphinx.

• Iniciando
  • Configurando fontes de documentação
  • Definindo estrutura do documento
  • Adicionando conteúdo
  • Executando a montagem
  • Documentando objetos
  • Configuração Básica
  • Autodoc
  • Intersphinx
  • Mais tópicos para cobrir
• Instalando Sphinx
  • Visão Geral
  • Linux
  • macOS
  • Windows
  • Instalar a partir do PyPI
  • Docker
  • Instalar a partir dos fontes
• reStructuredText
  • Primer do reStructuredText
  • Roles
  • Diretivas
  • Listas de campo
  • Domains
• Markdown
  • Configuração
• Configuração
  • Informação do Projeto
  • Configuração Geral
  • Opções para internacionalização
  • Options for Math
  • Opções para saída HTML
  • Options for Single HTML output
  • Opções para ajuda saída HTML
  • Opções para saída Ajuda Apple
  • Opções para saída epub
  • Opções para saída LaTeX
  • Opções para saída texto
  • Opções para saída página manual
  • Opções para saida TexInfo
  • Opções para saída QtHelp
  • Opções para construtor linkcheck
  • Opções para construtor XML
  • Options for the C domain
  • Opções para domínio C++
  • Options for the Python domain
• Builders
  • Detalhes Construtor de Serialização
• Extensões
  • Extensões internas
  • Extensões Terceiros
• HTML Theming
  • Builders
  • Themes
• Internacionalização
  • Detalhes da Internacionalização Sphinx
  • Traduzindo com sphinx-intl
  • Usando o Serviço Transifex para time tradutotes
  • Contribuindo para tradução Referência Sphinx
• Integração Setuptools
  • Usando integração setuptools
  • Opções para integração setuptools
• Sphinx Web Support
  • Web Suporte Início Rápido
  • Classe WebSupport
  • Adaptadores de Busca
  • Armazenamento de Retaguarda