Counteúdo Documentação Sphinx

Primeiros passos

• Iniciando
  • Configurando fontes de documentação
  • Definindo estrutura do documento
  • Adicionando conteúdo
  • Executando a montagem
  • 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: Build your first project
  • Primeiros passos
    • Setting up your project and development environment
    • Creating the documentation layout
  • First steps to document your project using Sphinx
    • Building your HTML documentation
    • Building your documentation in other formats
  • More Sphinx customization
    • Enabling a built-in extension
    • Using a third-party HTML theme
  • Narrative documentation in Sphinx
    • Structuring your documentation across multiple pages
    • Adding cross-references
  • Describing code in 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
  • Appendix: Deploying a Sphinx project 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 campo
    • Domínios
  • Markdown
    • Configuração
  • Configuração
    • Informação do Projeto
    • Configuração Geral
    • Opções para internacionalização
    • Opções para Math
    • Opções para saída HTML
    • Opções para a 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 manual
    • Opções para saida 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
    • Exemplo de arquivo configuração
  • Builders
    • 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
  • 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
• Estendendo o Sphinx
  • 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
  • HTML theme development
    • Criando temas
    • Distribuir seu tema como um pacote Python
    • Criando Moldes
• Criando Moldes
  • Do I need to use Sphinx’s templates to produce HTML?
  • Jinja/Sphinx Templating Primer
  • Working with the builtin templates
    • Blocos
    • Configuration Variables
    • Helper Functions
    • Global Variables
• Configuração LaTeX
  • The latex_elements configuration setting
  • The sphinxsetup configuration setting
  • Additional CSS-like 'sphinxsetup' keys
  • LaTeX macros and environments
    • Macros
    • Ambientes
    • Miscelânea
• Desenvolvendo extensões para Sphinx
  • Objetos importantes
  • Fases Construção
  • Extensões Metadados
  • APIs usadas para gravar 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
• Contribute to 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
  • Organization of the Sphinx project
    • Core developers
    • Other contributors
  • Código de Conduta do Sphinx
  • Autores do Sphinx
    • Maintainers
    • Contributors
    • Included software
• FAQ do Sphinx
  • Como eu faço…
  • Usar Sphinx com…
  • Sphinx vs. Docutils
  • Informações de epub
  • Informações de Texinfo
    • Exibindo links
    • Notas

Referência

• Command-Line Tools
  • Aplicações Núcleo
    • sphinx-quickstart
    • sphinx-build
  • Aplicações Adicionais
    • sphinx-apidoc
    • sphinx-autogen
• 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 tema nature
  • Documentação usando outro tema padrão
  • Documentation using sphinx_rtd_theme
  • Documentação usando sphinx_bootstrap_theme
  • Documentação usando configuração de tema ou integrado em 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