Sphinxウェブサポート

Added in version 1.1.

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

注釈

Historical context: Web Support originated from the Pocoo community, the original creators of Sphinx, Jinja, Flask, Pygments, and more. Web Support was part of a plan to create a forum application that tied together Jinja, Flask, Sphinx, etc. The core goal behind Web Support was to enable a user editing and suggestion layer on top of documentation. While the concept has merit, the feature has seen limited adoption and development over the years. As of 2025, there are few real-world examples of its use. See sphinx-websupport-app for one such example.

• Webサポートクイックスタート
  • Building documentation data
  • Integrating Sphinx documents into your web-app
    • 認証
  • Performing searches
  • Comments & proposals
  • Comment moderation
• The WebSupport class
  • WebSupport
  • メソッド
    • WebSupport.build()
    • WebSupport.get_document()
    • WebSupport.get_data()
    • WebSupport.add_comment()
    • WebSupport.process_vote()
    • WebSupport.get_search_results()
• Search adapters
  • BaseSearch
  • メソッド
    • BaseSearch.init_indexing()
    • BaseSearch.finish_indexing()
    • BaseSearch.feed()
    • BaseSearch.add_document()
    • BaseSearch.query()
    • BaseSearch.handle_query()
    • BaseSearch.extract_context()
• Storage backends
  • 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()

Previous

国際化

Next

Webサポートクイックスタート