Counteúdo Documentação Sphinx

Primeiros passos

• 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
• Instalando Sphinx
  • Visão geral
  • Linux
    • Debian/Ubuntu
    • RHEL, CentOS
    • Outras distribuições
  • macOS
    • Homebrew
    • MacPorts
    • Anaconda
  • Windows
    • Chocolatey
    • Outros Métodos
  • Instalar a partir do PyPI
    • Usando ambientes virtuais
  • Docker
  • Instalar a partir dos fontes
• Tutorial: 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
    • Building your HTML documentation
    • Building your documentation in other formats
  • Mais personalização do Sphinx
    • Enabling a built-in extension
    • Using a third-party HTML theme
  • Documentação narrativa no Sphinx
    • Structuring your documentation across multiple pages
    • Adding cross-references
  • Descrevendo código no Sphinx
    • Python
    • Other languages (C, C++, others)
  • 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
    • Sphinx-friendly deployment options
    • Embracing the “Docs as Code” philosophy
    • Publishing your documentation sources
    • Publishing your HTML documentation
  • Aonde ir a partir daqui

Guias de usuário

• Usando Sphinx
  • reStructuredText
    • Primer do reStructuredText
    • Roles
    • Diretivas
    • Listas de campos
    • MOVED: Domains
  • Markdown
    • Configuração
  • Sintaxe de referência cruzada
    • Fazendo referência cruzada de qualquer coisa
    • Objetos de referência cruzada
    • Referência cruzada de locais arbitrários
    • Cross-referencing documents
    • Referencing downloadable files
    • Cross-referencing figures by figure number
    • Cross-referencing other items of interest
  • Configuração
    • Informações do projeto
    • Configurações gerais
    • Opções para internacionalização
    • Opções para Math
    • 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
    • Opções para construtor linkcheck
    • Opções para construtor XML
    • Opções para o domínio C
    • Opções para domínio C++
    • Opções para o domínio Python
    • Opções para o domínio JavaScript
    • Exemplo de arquivo 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 Construtor de Serialização
  • Domínios
    • Marcação Básica
    • Built-in domains
    • More domains
  • Extensões
    • Extensões embutidas
    • Extensões de terceiros
  • HTML Theming
    • Construtores
    • Themes
  • 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
    • Web Suporte Início Rápido
    • Classe WebSupport
    • Adaptadores de Busca
    • Armazenamento de Retaguarda
• Writing Sphinx Extensions
  • Visão geral do desenvolvimento de extensões
    • Fazer uma extensão depender de outra extensão
  • Tutoriais de extensão
    • Developing a “Hello world” extension
    • Developing a “TODO” extension
    • Developing a “recipe” extension
    • Developing autodoc extension for IntEnum
  • Configurando construtores
    • Descubra construtores por ponto de entrada
  • Criando Moldes
    • Do I need to use Sphinx’s templates to produce HTML?
    • Jinja/Sphinx Templating Primer
    • Working with the builtin templates
  • Desenvolvimento de tema HTML
    • Criando temas
    • Distribuir seu tema como um pacote Python
    • Criando Moldes
• Configuração 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
• API do Sphinx para extensões
  • Objetos importantes
  • Fases da construção
  • Metadados das extensões
  • APIs usadas para escrever extensões
    • Application API
    • Project API
    • Contruir ambiente API
    • Builder API
    • Environment Collector API
    • API Marcações Docutils
    • Domain API
    • Parser API
    • Doctree node classes added by Sphinx
    • Logging API
    • API i18n
    • Utilities
    • APIs em Desuso

Comunidade

• Obtenha
• Contribuir para o Sphinx
  • Contribuindo para o Sphinx
    • Get help
    • Relatórios de bugs e solicitação de recursos
    • Contribute code
    • Contribute documentation
    • Debugging tips
  • Processo de lançamento do Sphinx
    • Versioning
    • Recurso em Desuso
    • Política de Desuso
    • Python version support policy
    • Procedimentos de lançamento
  • Organização do projeto Sphinx
    • Core developers
    • 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
  • Informações do projeto
  • Configurações gerais
  • Opções para internacionalização
  • Opções para Math
  • 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
  • Opções para construtor linkcheck
  • Opções para construtor XML
  • Opções para o domínio C
  • Opções para domínio C++
  • Opções para o domínio Python
  • Opções para o domínio JavaScript
  • Exemplo de arquivo configuração
• Extensões
  • Extensões embutidas
    • sphinx.ext.autodoc - Inclui documentação das docstrings
    • sphinx.ext.autosectionlabel – Permite referenciar seção usando seu título
    • sphinx.ext.autosummary – Gera resumos autodoc
    • sphinx.ext.coverage – Coleta estatísticas doc
    • sphinx.ext.doctest – Trechos de teste na documentação
    • sphinx.ext.duration – Mede durações de processamento 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
  • Roles
    • Sintaxe de referência cruzada
    • Inline code highlighting
    • Math
    • Other semantic markup
    • 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
    • Math
    • Grammar production displays
  • Listas de campos
    • Metadados File-wide
    • Special metadata fields
  • MOVED: Domains
    • MOVED: Basic Markup
    • MOVED: Python Domain
    • MOVED: C Domain
    • MOVED: C++ Domain
    • MOVED: Standard Domain
    • MOVED: JavaScript Domain
    • MOVED: reStructuredText Domain
    • MOVED: Math Domain
    • MOVED: More domains
• Glossário
• Changelog
• 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 sphinx_rtd_theme
  • Documentação usando sphinx_bootstrap_theme
  • Documentação usando pydata_sphinx_theme
  • 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