Sphinxウェブサポート

Added in version 1.1.

SphinxはSphinxドキュメントをウェブアプリケーションに簡単に組み込めるようにするための、Python APIを提供しています。詳しくは、 Webサポートクイックスタート を参照してください。

• Webサポートクイックスタート
  • ドキュメントデータのビルド
  • Sphinxドキュメントをウェブアプリケーションに統合
    • 認証
  • 検索の実行
  • コメント＆提案
  • コメントのモデレート
• WebSupportクラス
  • WebSupport
  • メソッド
    • WebSupport.build()
    • WebSupport.get_document()
    • WebSupport.get_data()
    • WebSupport.add_comment()
    • WebSupport.process_vote()
    • WebSupport.get_search_results()
• 検索アダプタ
  • BaseSearch
  • メソッド
    • BaseSearch.init_indexing()
    • BaseSearch.finish_indexing()
    • BaseSearch.feed()
    • BaseSearch.add_document()
    • BaseSearch.query()
    • BaseSearch.handle_query()
    • BaseSearch.extract_context()
• ストレージバックエンド
  • StorageBackend
  • メソッド
    • 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()