Sphinx Web Support

Adicionado na versão 1.1.

Sphinx fornece uma API do Python para integrar facilmente a documentação do Sphinx em sua aplicação web. Para saber mais leia o Início rápido ao suporte web.

Nota

Contexto histórico: O Web Support teve origem na comunidade Pocoo, criadora original do Sphinx, Jinja, Flask, Pygments e outras tecnologias. O Web Support fazia parte de um plano para criar uma aplicação de fórum que integrasse Jinja, Flask, Sphinx, etc. O objetivo principal do Web Support era permitir uma camada de edição e sugestões do usuário sobre a documentação. Embora o conceito tenha mérito, o recurso teve adoção e desenvolvimento limitados ao longo dos anos. Em 2025, havia poucos exemplos práticos de seu uso. Veja sphinx-websupport-app para um exemplo.

• Início rápido ao suporte web
  • Construindo dados da documentação
  • Integrando documentos Sphinx em sua aplicação web
    • Autenticação
  • Realizando pesquisas
  • Comentários e propostas
  • Moderação de comentário
• A classe WebSupport
  • WebSupport
  • Métodos
    • WebSupport.build()
    • WebSupport.get_document()
    • WebSupport.get_data()
    • WebSupport.add_comment()
    • WebSupport.process_vote()
    • WebSupport.get_search_results()
• Adaptadores de pesquisa
  • BaseSearch
  • Métodos
    • BaseSearch.init_indexing()
    • BaseSearch.finish_indexing()
    • BaseSearch.feed()
    • BaseSearch.add_document()
    • BaseSearch.query()
    • BaseSearch.handle_query()
    • BaseSearch.extract_context()
• Backends de armazenamento
  • StorageBackend
  • Métodos
    • StorageBackend.pre_build()
    • StorageBackend.add_node()
    • StorageBackend.post_build()
    • StorageBackend.add_comment()
    • StorageBackend.delete_comment()
    • StorageBackend.get_data()
    • StorageBackend.process_vote()
    • StorageBackend.update_username()
    • StorageBackend.accept_comment()

Previous

Internacionalização

Next

Início rápido ao suporte web