Counteúdo Documentação Sphinx

O básico

• Instalando Sphinx
  • Pacote PyPI
  • Pacote conda
  • Gerenciador de pacotes específico do sistema operacional
    • Linux
    • macOS
    • Windows
  • Docker
  • Instalação da versão de desenvolvimento mais recente
  • Instalar a partir dos fontes
• Primeiros passos
  • Configurando fontes de documentação
  • Definindo a estrutura do documento
  • Adicionando conteúdo
  • Construindo
  • Documentando objetos
    • enumerate()
  • Configuração básica
  • Autodoc
  • Intersphinx
  • Mais tópicos para cobrir
• Construa seu primeiro projeto
  • Primeiros passos
    • Configurando seu projeto e ambiente de desenvolvimento
    • Criando o layout da documentação
  • Primeiros passos para documentar seu projeto usando Sphinx
    • Construindo sua documentação HTML
    • Construindo sua documentação em outros formatos
  • Mais personalização do Sphinx
    • Habilitando uma extensão embutida
    • Usando um tema HTML de terceiros
  • Documentação narrativa no Sphinx
    • Estruturando sua documentação em múltiplas páginas
    • Adicionando referências cruzadas
  • Descrevendo código no Sphinx
    • Python
    • Outras linguagens (C, C++, outros)
  • Geração automática de documentação a partir do código
    • Reutilizando assinaturas e docstrings com autodoc
    • Gerando referências de API abrangentes
  • Apêndice: Fazendo deploy de um projeto Sphinx online
    • Opções de deployment compatíveis com Sphinx
    • Abraçando a filosofia “Documentação como Código”
    • Publicando suas fontes de documentação
    • Publicando sua documentação em HTML
  • Aonde ir a partir daqui

Guias de usuário

• Usando Sphinx
  • reStructuredText
    • Primer do reStructuredText
    • Papéis
    • Diretivas
    • Listas de campos
    • MOVIDO: Domínios
  • Markdown
    • Configuração
  • Referências cruzadas
    • Syntax
    • Objetos de referência cruzada
    • Referência cruzada de locais arbitrários
    • Fazendo referência cruzada a documentos
    • Fazendo referência a arquivos baixáveis
    • Fazendo referência cruzada a figuras por número de figura
    • Fazendo referência cruzada a outros itens de interesse
    • Fazendo referência cruzada de qualquer coisa
  • Configuração
    • Tags do projeto
    • Informações do projeto
    • Configurações gerais
    • Opções do construtor
    • Domain options
    • Opções Extensão
    • Example configuration file
  • Construtores
    • StandaloneHTMLBuilder
    • DirectoryHTMLBuilder
    • SingleFileHTMLBuilder
    • HTMLHelpBuilder
    • QtHelpBuilder
    • AppleHelpBuilder
    • DevhelpBuilder
    • Epub3Builder
    • LaTeXBuilder
    • TextBuilder
    • ManualPageBuilder
    • TexinfoBuilder
    • SerializingHTMLBuilder
    • PickleHTMLBuilder
    • JSONHTMLBuilder
    • MessageCatalogBuilder
    • ChangesBuilder
    • DummyBuilder
    • CheckExternalLinksBuilder
    • XMLBuilder
    • PseudoXMLBuilder
    • Detalhes de construtores de serialização
  • Domínios
    • Domínios embutidos
    • Domínios de terceiros
    • Marcação básica
  • Extensões
    • Extensões embutidas
    • Extensões de terceiros
  • HTML theming
    • Construtores
    • Temas
  • Internacionalização
    • Detalhes da internacionalização do Sphinx
    • Traduzindo com sphinx-intl
    • Usando o serviço Transifex para tradução em equipe
    • Usando o serviço Weblate para tradução em equipe
    • Contribuindo para tradução das referências do Sphinx
    • Progresso e estatísticas de tradução
  • Sphinx Web Support
    • Início rápido ao suporte web
    • A classe WebSupport
    • Adaptadores de pesquisa
    • Backends de armazenamento
• Estendendo o Sphinx
  • Tutoriais
    • Estendendo a sintaxe com papéis e diretivas
    • Estendendo o processo de construção
    • Adicionando um domínio de referência
    • Desenvolvendo extensões autodoc
  • Como fazer
    • Depender de outra extensão
    • Configurando construtores
  • Desenvolvimento de tema HTML
    • Criando temas
    • Distribuir seu tema como um pacote Python
    • Styling with CSS
    • Criando modelos
• API do Sphinx
  • Objetos importantes
  • Fases da construção
  • Metadados das extensões
  • APIs usadas para escrever extensões
    • API de aplicação
    • API de retorno de chamada de eventos
    • API de projeto
    • API de ambiente de construção
    • API de construtor
    • API de gerenciador de eventos
    • API do coletor de ambiente
    • API de marcações do Docutils
    • API de domínio
    • Parser API
    • Classes de nós de doctree adicionadas pelo Sphinx
    • Logging API
    • API i18n
    • Utilitários
    • API de teste
    • APIs descontinuadas
• Personalização de LaTeX
  • A definição da configuração latex_elements
  • A definição da configuração sphinxsetup
  • Chaves adicionais de 'sphinxsetup' no estilo CSS
  • Ambientes e macros LaTeX
    • Macros
    • The \sphinxbox command
    • Ambientes
    • Miscelânea

Comunidade

• Obtenha suporte
• Contribuir para o Sphinx
  • Contribuindo para o Sphinx
    • Obter ajuda
    • Relatórios de bugs e solicitação de recursos
    • Contribuir com código
    • Contribuir com documentação
    • Traduções
    • Dicas de depuração
    • Atualizando arquivos gerados
  • AI Policy
    • Responsibility
    • Disclosure
    • Code Quality
    • Copyright
    • Communication
    • AI Agents
    • Other Resources
    • Acknowledgements
  • Processo de lançamento do Sphinx
    • Versionamento
    • Descontinuando um recurso
    • Política de descontinuação
    • Política de suporte a versões do Python
    • Procedimentos de lançamento
  • Organização do projeto Sphinx
    • Desenvolvedores core
    • Outros contribuidores
  • Código de Conduta do Sphinx
• FAQ do Sphinx
  • Como eu faço…
  • Usar Sphinx com…
  • Sphinx vs. Docutils
  • Informações de epub
  • Informações de Texinfo
    • Exibindo links
    • Notas
• Autores do Sphinx
  • Mantenedores
  • Contribuidores
  • Antigos mantenedores

Referência

• Ferramentas de linha de comando
  • Aplicações principais
    • sphinx-quickstart
    • sphinx-build
  • Aplicações adicionais
    • sphinx-apidoc
    • sphinx-autogen
• Configuração
  • Tags do projeto
  • Informações do projeto
    • project
    • author
    • copyright
    • project_copyright
    • version
    • release
  • Configurações gerais
    • needs_sphinx
    • extensions
    • needs_extensions
    • manpages_url
    • today
    • today_fmt
    • Opções para numeração de figuras
    • Opções de realce
    • Opções para solicitações HTTP
    • Opções para internacionalização
    • Opções para marcação
    • Opções para matemática
    • Opções para modo nitpicky
    • Opções para assinaturas de objetos
    • Opções de arquivos fonte
    • Opções para aspas inteligentes
    • Opções de temas
    • Opções para controle de avisos
  • Opções do construtor
    • Opções para saída HTML
    • Opções para saída Single HTML
    • 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 de manual
    • Opções para saída TexInfo
    • Opções para saída QtHelp
    • Options for XML output
    • Opções para construtor linkcheck
  • Domain options
    • Opções para o domínio C
    • Opções para domínio C++
    • Opções para o domínio JavaScript
    • Opções para o domínio Python
  • Opções Extensão
  • Example configuration file
• Extensões
  • Extensões embutidas
    • sphinx.ext.apidoc – Generate API documentation from Python packages
    • sphinx.ext.autodoc - Inclui documentação das docstrings
    • sphinx.ext.autosectionlabel – Permite referenciar seções por seu título
    • sphinx.ext.autosummary – Gera resumos autodoc
    • sphinx.ext.coverage – Coleta estatísticas de cobertura da documentação
    • sphinx.ext.doctest – Trechos de teste na documentação
    • sphinx.ext.duration – Mede durações de processamento do Sphinx
    • sphinx.ext.extlinks – Marcação para encurtar links externos
    • sphinx.ext.githubpages – Publicar docs HTML em páginas GitHub
    • sphinx.ext.graphviz – Adiciona gráficos Graphviz
    • sphinx.ext.ifconfig – Inclui conteúdo baseado em configuração
    • sphinx.ext.imgconverter – Um conversor de imagem de referência usando o Imagemagick
    • sphinx.ext.inheritance_diagram – Inclui diagramas de herança
    • sphinx.ext.intersphinx – Link para documentação outros projetos
    • sphinx.ext.linkcode - Adiciona links externos ao código-fonte
    • Suporte matemático para saídas HTML no Sphinx
    • sphinx.ext.napoleon – Suporte para doctrings de estilo NumPy e Google
    • sphinx.ext.todo – Suporta itens todo
    • sphinx.ext.viewcode – Adiciona links ao código destacado
  • Extensões de terceiros
    • Onde colocar suas próprias extensões?
• reStructuredText
  • Primer do reStructuredText
    • Parágrafos
    • Marcação Inline
    • Listas e Blocos Transcritos
    • Blocos literais
    • Blocos doctest
    • Tabelas
    • Hiperlinks
    • Seções
    • Listas de campos
    • Roles
    • Marcação Explícita
    • Diretivas
    • Imagens
    • Notas de Rodapé
    • Citações
    • Substituições
    • Comentários
    • Metadados de HTML
    • Codificação Página
    • Pegadinhas
  • Papéis
    • Referências cruzadas
    • Realce de código em linha
    • Mathemática
    • Outras marcações semânticas
    • Substituições
  • Diretivas
    • Tabela de conteúdo
    • Marcação de nível de parágrafo
    • Mostrando exemplos de código
    • Glossário
    • Marcação Meta-Informação
    • Marcação geração índice
    • Incluindo conteúdo baseado em tags
    • Tabelas
    • Mathemática
    • Exibições de produção gramatical
  • Listas de campos
    • Metadados de todo o arquivo
    • Campos especiais de metadados
  • MOVIDO: Domínios
    • MOVIDO: Marcação Básica
    • MOVIDO: Domínio Python
    • MOVIDO: Domínio C
    • MOVIDO: Domínio C++
    • MOVIDO: Domínio padrão
    • MOVIDO: Domínio JavaScript
    • MOVIDO: Domínio reStructuredText
    • MOVIDO: Domínio Math
    • MOVIDO: Mais domínios
• Glossário
• Changelog
  • Release 9.1.1 (in development)
    • Erros corrigidos
  • Release 9.1.0 (released Dec 31, 2025)
    • Dependências
    • Funcionalidades adicionadas
    • Erros corrigidos
  • Versões anteriores
    • Sphinx 9.0
    • Sphinx 8.2
    • Sphinx 8.1
    • Sphinx 8.0
    • Sphinx 7.4
    • Sphinx 7.3
    • Sphinx 7.2
    • Sphinx 7.1
    • Sphinx 7.0
    • Sphinx 6.2
    • Sphinx 6.1
    • Sphinx 6.0
    • Sphinx 5.3
    • Sphinx 5.2
    • Sphinx 5.1
    • Sphinx 5.0
    • Sphinx 4.5
    • Sphinx 4.4
    • Sphinx 4.3
    • Sphinx 4.2
    • Sphinx 4.1
    • Sphinx 4.0
    • Sphinx 3.5
    • Sphinx 3.4
    • Sphinx 3.3
    • Sphinx 3.2
    • Sphinx 3.1
    • Sphinx 3.0
    • Sphinx 2.4
    • Sphinx 2.3
    • Sphinx 2.2
    • Sphinx 2.1
    • Sphinx 2.0
    • Sphinx 1.8
    • Sphinx 1.7
    • Sphinx 1.6
    • Sphinx 1.5
    • Sphinx 1.4
    • Sphinx 1.3
    • Sphinx 1.2
    • Sphinx 1.1
    • Sphinx 1.0
    • Sphinx 0.6
    • Sphinx 0.5
    • Sphinx 0.4
    • Sphinx 0.3
    • Sphinx 0.2
    • Sphinx 0.1
• Projetos usando Sphinx
  • Documentação usando o tema alabaster
  • Documentação usando o tema clássico
  • Documentação usando o tema sphinxdoc
  • Documentação usando o tema nature
  • Documentação usando outro tema embutido
  • Documentação usando o Read the Docs Sphinx Theme
  • Documentação usando Sphinx Bootstrap Theme
  • Documentação usando PyData Sphinx Theme
  • Documentação usando o tema Furo
  • Documentação usando um tema personalizado ou integrado em um website
  • Páginas iniciais e outros sites que não são de documentação
  • Livros produzidos usando Sphinx
  • Produções usando Sphinx
  • Projetos integrando a funcionalidade do Sphinx