Sphinx Web Support

New in version 1.1.

Sphinx provides a Python API to easily integrate Sphinx documentation into your web application. To learn more read the Web Support Quick Start.

• Web Support Quick Start
  • Building Documentation Data
  • Integrating Sphinx Documents Into Your Webapp
    • Authentication
  • Performing Searches
  • Comments & Proposals
  • Comment Moderation
• The WebSupport Class
  • WebSupport
  • Methods
    • WebSupport.build()
    • WebSupport.get_document()
    • WebSupport.get_data()
    • WebSupport.add_comment()
    • WebSupport.process_vote()
    • WebSupport.get_search_results()
• Search Adapters
  • BaseSearch
  • Methods
    • BaseSearch.init_indexing()
    • BaseSearch.finish_indexing()
    • BaseSearch.feed()
    • BaseSearch.add_document()
    • BaseSearch.query()
    • BaseSearch.handle_query()
    • BaseSearch.extract_context()
• Storage Backends
  • StorageBackend
  • Methods
    • 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()