Counteúdo Documentação Sphinx
- Instalando Sphinx
- Primeiros passos
- Construa seu primeiro projeto
- Usando Sphinx
- reStructuredText
- Markdown
- 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
- 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
- Extensões
- HTML theming
- Internacionalização
- Sphinx Web Support
- Estendendo o Sphinx
- 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 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
- Obtenha suporte
- Contribuir para o Sphinx
- FAQ do Sphinx
- Autores do Sphinx
- Ferramentas de linha de comando
- Configuração
- Tags do projeto
- Informações do projeto
- 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 Extensão
- Example configuration file
- Extensões
- Extensões embutidas
sphinx.ext.autodoc
- Inclui documentação das docstringssphinx.ext.autosectionlabel
– Permite referenciar seções por seu títulosphinx.ext.autosummary
– Gera resumos autodocsphinx.ext.coverage
– Coleta estatísticas de cobertura da documentaçãosphinx.ext.doctest
– Trechos de teste na documentaçãosphinx.ext.duration
– Mede durações de processamento Sphinxsphinx.ext.extlinks
– Marcação para encurtar links externossphinx.ext.githubpages
– Publicar docs HTML em páginas GitHubsphinx.ext.graphviz
– Adiciona gráficos Graphvizsphinx.ext.ifconfig
– Inclui conteúdo baseado em configuraçãosphinx.ext.imgconverter
– Um conversor de imagem de referência usando o Imagemagicksphinx.ext.inheritance_diagram
– Inclui diagramas de herançasphinx.ext.intersphinx
– Link para documentação outros projetossphinx.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 Googlesphinx.ext.todo
– Suporta itens todosphinx.ext.viewcode
– Adiciona links ao código destacado
- Extensões de terceiros
- Extensões embutidas
- reStructuredText
- Glossário
- Changelog
- Versão 8.2.0 (em desenvolvimento)
- Versões anteriores
- 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